@terrascale/sdk 0.0.2 → 0.0.3

package/types/v1/ids.d.ts

@@ -5,16 +5,13 @@
  */
 export function requireName(kind: "database" | "collection", name: unknown): string;
 /**
- * The producer resolves this opaque catalog project id (normally a UUID), not its display name.
+ * The catalog project ID is a canonical ULID; database and collection routes use names.
  * @param {unknown} project
- * @returns {string}
- */
-export function requireProject(project: unknown): string;
-/**
- * @param {unknown} id
- * @returns {string}
+ * @returns {import("../ids.js").EntityId}
  */
-export function requireDocumentId(id: unknown): string;
+export function requireProject(project: unknown): import("../ids.js").EntityId;
+/** @param {unknown} id @returns {import("../ids.js").EntityId} */
+export function requireDocumentId(id: unknown): import("../ids.js").EntityId;
 /**
  * @param {unknown} version
  * @returns {string}
@@ -33,12 +30,3 @@ export function parseU64(value: unknown): bigint | undefined;
  * @returns {bigint}
  */
 export function requireU64(value: unknown, what: string): bigint;
-/**
- * The deterministic document ID for a natural key in a collection:
- * `uuidv5(uuidv5(NAMESPACE_URL, "terrabase:collection:" + collection), key)`.
- * Uses WebCrypto, so it works in Node.js, browsers and workers.
- * @param {string} collection
- * @param {string} key
- * @returns {Promise<string>}
- */
-export function documentIdFor(collection: string, key: string): Promise<string>;

package/types/v1/shapes.d.ts

@@ -42,12 +42,12 @@ export type V1ShapeRequest = {
 };
 export type V1ShapeOp = {
     readonly op: "upsert";
-    readonly id: string;
+    readonly id: import("../ids.js").EntityId;
     readonly version: string;
     readonly document: JsonObject;
 } | {
     readonly op: "delete";
-    readonly id: string;
+    readonly id: import("../ids.js").EntityId;
 };
 export type V1ShapeChange = {
     readonly offset: string;

package/types/v1/terrabase-v1.d.ts

@@ -33,7 +33,7 @@ export class V1Collection {
      */
     put(id: string, document: JsonInputObject, options?: V1WriteOptions): Promise<V1WriteResult>;
     /**
-     * Creates a document under a server-generated UUIDv7.
+     * Creates a document under a server-generated ULID.
      * @param {JsonInputObject} document
      * @param {V1CreateOptions} [options]
      * @returns {Promise<V1WriteResult>}
@@ -107,7 +107,7 @@ export class V1Transaction {
     get size(): number;
     /**
      * Adds a create (a put requiring absence). Omit `id` to have the server
-     * generate a UUIDv7, returned in the op's result.
+     * generate a ULID, returned in the op's result.
      * @param {string} collection
      * @param {JsonInputObject} document
      * @param {string} [id]
@@ -211,7 +211,7 @@ export class V1Database {
     #private;
 }
 /**
- * A TerraBase v1 data-plane client for one project and `tb_` API key. The key is held
+ * A TerraBase v1 data-plane client for one project and access token. The token is held
  * privately; it is never serialized, logged or forwarded to redirects.
  */
 export class TerraBaseV1Client {

package/types/v1/transport.d.ts

@@ -23,7 +23,7 @@ export class BodyTransportError extends Error {
     /** @param {unknown} cause */
     constructor(cause: unknown);
 }
-/** Internal transport bound to one data key. */
+/** Internal transport bound to one project credential. */
 export class V1Transport {
     /**
      * @param {Response} response
@@ -85,7 +85,7 @@ export type V1EndpointResolver = (context: V1EndpointContext) => string | Promis
 export type TerraBaseV1ClientConfig = {
     project: string;
     /**
-     * A tb_ API key; held privately.
+     * A ts-auth project access JWT (or a legacy C# tb_ key); held privately.
      */
     token: string;
     baseUrl?: string | undefined;