0.2.0: Databases, Data Flows, and business context
This SDK release adds managed database access and tools to author, run, and publish data workflows. Business context and revision controls are also available through the public API (subject to your API key’s permissions).
Managed databases
Use client.databases to create and inspect databases, define tables, read records, and submit transactions that insert, update, or delete records. Database creation requires an eligible Enterprise plan and database creation admin permission. Provisioning is asynchronous; read the database status before using it. Updates and deletes require the record’s version token to reject stale writes.
Data Flows and operations
Create Data Flows, connect their processing steps, and save operation code through client.dataFlows and client.operations. Run drafts and inspect completed output before publishing. Operations also support schedules and pause/resume controls; pausing preserves the schedule, and scheduling does not publish draft code. Follow the Data Flow guide for a complete example.
Facts and skills
Manage organization facts with client.facts, including business definitions, formulas, and baselines. Use client.skills for shared workspace instructions and client.organizationSkills for shared organization instructions. Facts require an organization-scoped request. The business context guide covers both interfaces.
Revision controls and dashboard source
Use client.revisions to inspect saved history, read earlier revisions, restore drafts, and publish supported resources. Check the returned capabilities before restoring or publishing; Data Flow roots support publication but have no graph history. Restoring an operation does not run or publish it. See the restore and publish guide.
Read and replace an existing dashboard’s TSX source through client.dashboards. Dashboard source saves take effect immediately. Pass the returned revision and data run on writes so newer edits are protected.
Upgrade to 0.2.0
Install the release with:
bun add @permute/sdk@0.2.0
This release adds client methods to the 0.1.2 SDK. New authoring methods require the current revision or version token where specified. On a 409 conflict, read the latest state and reconcile your changes before retrying. Check the API reference for each method’s permissions and request fields.
0.1.2: Dataset downloads and deletion
Added dataset download and deletion methods. This is the last published version before the changelog began; earlier releases are listed in the npm version history.