Commit to stream via js-client

Speckle Help Developers
3

heya!

as dim mentioned, we don’t have a full client yet. if you want to keep it simple, you can simply dump your json objects and send them using objectCreate from the graphql api or the /objects/${streamId} endpoint on the REST api

however, if you have a lot of data and want to use the Special Speckle Stuff™ like detaching (props prepended with an @) or chunking (props prepended with a @(chunkSize)) - click the links if you’re not familiar with what this means- you’ll need to do a bit more work.

I’ll gladly walk you through how I’m doing in Speckle SketchUp - although it is still a bit WIP. however, I believe as long as you give it a single “base object” (dict with a speckle_type prop), it should work as is and you can drop it into whatever you’re doing! you’ll just need to follow these steps as I’ve done in the Speckle Sketchup StreamCard

  1. instantiate a BaseObjectSerializer (this guy)

  2. pass a speckle “base object” (dict with a speckle_type: 'Base' prop) to writeJson()

  3. batch the serialised objects with batchObjects()

  4. send each batch to the server /objects/${streamId} endpoint

  5. create a commit on your stream with the root object id you got from writeJson()

if you run into any problems or need any more explanation on something, just let me know! also, if what’s there isn’t quite working how you need it, I am happy to talk through what is actually going on in more detail so you can work through it yourself! :rocket:

4 Likes