@sudobility/screenwriter_types 0.1.6 → 0.1.8

package/dist/index.js

@@ -66,6 +66,10 @@ const ERROR_TABLE = [
   ["RATE_LIMITED", 429],
   ["QUOTA_EXCEEDED", 429],
   ["INSUFFICIENT_CREDITS", 402],
+  ["COUPON_NOT_FOUND", 404],
+  ["COUPON_EMAIL_MISMATCH", 403],
+  ["COUPON_ALREADY_REDEEMED", 409],
+  ["COUPON_EXPIRED", 410],
   ["AI_UNAVAILABLE", 503],
   ["AI_INPUT_TOO_LARGE", 413],
   ["AI_GENERATION_FAILED", 502],
@@ -146,14 +150,14 @@ const API_ROUTES = {
   health: r("GET", "/health", "P"),
   meGet: r("GET", "/me", "U,Kr"),
   mePatch: r("PATCH", "/me", "U"),
-  // B2 workspaces
-  workspacesList: r("GET", "/workspaces", "U,Kr"),
-  workspaceGet: r("GET", "/workspaces/:wid", "U,Kr", "workspace.read"),
+  // B2 entities
+  entitiesList: r("GET", "/entities", "U,Kr"),
+  entityGetDetails: r("GET", "/entities/:entityId", "U,Kr", "entity.read"),
   // B2 projects
-  projectsList: r("GET", "/workspaces/:wid/projects", "U,Kr", "project.read"),
+  projectsList: r("GET", "/entities/:wid/projects", "U,Kr", "project.read"),
   projectCreate: r(
     "POST",
-    "/workspaces/:wid/projects",
+    "/entities/:wid/projects",
     "U,Krw",
     "project.create"
   ),
@@ -375,39 +379,34 @@ const API_ROUTES = {
     "document.edit"
   ),
   // B8 tenancy, roles, sharing. Keys (K) only read members and /me/shared; everything else is user-only (403 API_KEY_FORBIDDEN).
-  workspaceCreate: r("POST", "/workspaces", "U"),
-  workspaceUpdate: r("PATCH", "/workspaces/:wid", "U", "workspace.update"),
-  workspaceDelete: r("DELETE", "/workspaces/:wid", "U", "workspace.delete"),
-  workspaceTransfer: r(
+  entityCreate: r("POST", "/entities", "U"),
+  entityUpdate: r("PATCH", "/entities/:entityId", "U", "entity.update"),
+  entityDelete: r("DELETE", "/entities/:entityId", "U", "entity.delete"),
+  entityTransfer: r(
     "POST",
-    "/workspaces/:wid/transfer",
+    "/entities/:entityId/transfer",
     "U",
-    "workspace.transfer"
+    "entity.transfer"
   ),
-  workspaceLeave: r("POST", "/workspaces/:wid/leave", "U", "workspace.leave"),
-  workspaceUsage: r("GET", "/workspaces/:wid/usage", "U", "workspace.read"),
-  workspaceAudit: r(
-    "GET",
-    "/workspaces/:wid/audit.csv",
-    "U",
-    "workspace.audit"
-  ),
-  membersList: r("GET", "/workspaces/:wid/members", "U,Kr", "members.read"),
+  entityLeave: r("POST", "/entities/:entityId/leave", "U", "entity.leave"),
+  managedEntityUsage: r("GET", "/entities/:entityId/usage", "U", "entity.read"),
+  entityAudit: r("GET", "/entities/:entityId/audit.csv", "U", "entity.audit"),
+  membersList: r("GET", "/entities/:wid/members", "U,Kr", "members.read"),
   memberUpdate: r(
     "PATCH",
-    "/workspaces/:wid/members/:uid",
+    "/entities/:wid/members/:uid",
     "U",
     "members.updateRole"
   ),
   memberRemove: r(
     "DELETE",
-    "/workspaces/:wid/members/:uid",
+    "/entities/:wid/members/:uid",
     "U",
     "members.remove"
   ),
-  invitationCreateWorkspace: r(
+  invitationCreateEntity: r(
     "POST",
-    "/workspaces/:wid/invitations",
+    "/entities/:entityId/invitations",
     "U",
     "members.invite"
   ),
@@ -423,9 +422,9 @@ const API_ROUTES = {
     "U",
     "share.manage"
   ),
-  workspaceInvitationsList: r(
+  entityInvitationsList: r(
     "GET",
-    "/workspaces/:wid/invitations",
+    "/entities/:entityId/invitations",
     "U",
     "members.invite"
   ),
@@ -433,6 +432,7 @@ const API_ROUTES = {
   invitationRenew: r("POST", "/invitations/:iid/renew", "U"),
   invitationCancel: r("DELETE", "/invitations/:iid", "U"),
   invitationAccept: r("POST", "/invitations/accept", "U"),
+  invitationAcceptById: r("POST", "/invitations/:iid/accept", "U"),
   invitationDecline: r("POST", "/invitations/:iid/decline", "U"),
   sharedWithMe: r("GET", "/me/shared", "U,Kr"),
   documentLock: r("POST", "/documents/:did/lock", "U", "document.lock"),
@@ -496,7 +496,12 @@ const API_ROUTES = {
   // B10 projection-backed reads, search, reports, packets (spec 05 §6.7.1, §6.7.2, §6.12, §6.14, §6.15, §6.17, §6.18, §6.22).
   // `?source=live|snapshot:<id>|version:<id>` selects the state a read answers from. Keys (K) read all of these; the report
   // and resolve POSTs are reads, so a read-only key may send them.
-  entitiesList: r("GET", "/documents/:did/entities", "U,Kr,L", "document.read"),
+  documentEntitiesList: r(
+    "GET",
+    "/documents/:did/entities",
+    "U,Kr,L",
+    "document.read"
+  ),
   entityGet: r(
     "GET",
     "/documents/:did/entities/:eid",
@@ -555,12 +560,7 @@ const API_ROUTES = {
   resolveBatch: r("POST", "/documents/:did/resolve", "U,Kr,L", "document.read"),
   resolveOne: r("GET", "/documents/:did/resolve", "U,Kr,L", "document.read"),
   documentSearch: r("GET", "/documents/:did/search", "U,Kr,L", "document.read"),
-  workspaceSearch: r(
-    "GET",
-    "/workspaces/:wid/search",
-    "U,Kr",
-    "workspace.read"
-  ),
+  workspaceSearch: r("GET", "/entities/:wid/search", "U,Kr", "entity.read"),
   search: r("GET", "/search", "U,Kr"),
   reportKinds: r("GET", "/reports/kinds", "U,Kr"),
   reportGet: r("GET", "/documents/:did/reports/:kind", "U,Kr,L", "reports.run"),
@@ -623,14 +623,14 @@ const API_ROUTES = {
   // trash-empty, workspace defaults and contacts are user-only (a key gets 403 API_KEY_FORBIDDEN).
   workspaceDocuments: r(
     "GET",
-    "/workspaces/:wid/documents",
+    "/entities/:wid/documents",
     "U,Kr",
     "project.read"
   ),
-  workspaceTrash: r("GET", "/workspaces/:wid/trash", "U,Kr", "project.read"),
+  workspaceTrash: r("GET", "/entities/:wid/trash", "U,Kr", "project.read"),
   workspaceTrashEmpty: r(
     "POST",
-    "/workspaces/:wid/trash/empty",
+    "/entities/:wid/trash/empty",
     "U",
     "project.purge"
   ),
@@ -694,39 +694,39 @@ const API_ROUTES = {
   ),
   workspaceDefaultsGet: r(
     "GET",
-    "/workspaces/:wid/defaults",
+    "/entities/:wid/defaults",
     "U,Kr",
-    "workspace.read"
+    "entity.read"
   ),
   workspaceDefaultsSet: r(
     "PUT",
-    "/workspaces/:wid/defaults",
+    "/entities/:wid/defaults",
     "U",
-    "workspace.update"
+    "entity.update"
   ),
   workspaceContactsList: r(
     "GET",
-    "/workspaces/:wid/contacts",
+    "/entities/:wid/contacts",
     "U",
-    "workspace.read"
+    "entity.read"
   ),
   workspaceContactsCreate: r(
     "POST",
-    "/workspaces/:wid/contacts",
+    "/entities/:wid/contacts",
     "U",
-    "workspace.update"
+    "entity.update"
   ),
   workspaceContactUpdate: r(
     "PATCH",
-    "/workspace-contacts/:cid",
+    "/entity-contacts/:cid",
     "U",
-    "workspace.update"
+    "entity.update"
   ),
   workspaceContactDelete: r(
     "DELETE",
-    "/workspace-contacts/:cid",
+    "/entity-contacts/:cid",
     "U",
-    "workspace.update"
+    "entity.update"
   ),
   // B16 imports, exports and watermark as jobs (spec 05 §6.18). `POST /imports*` and `/uploads/state` are `Krw`; exports are `Kr` (a read key may
   // export what it can read); the watermark lookup is user-only (403 API_KEY_FORBIDDEN for a key). The synchronous
@@ -754,15 +754,15 @@ const API_ROUTES = {
   ),
   watermarkLookup: r(
     "POST",
-    "/workspaces/:wid/watermark-lookup",
+    "/entities/:wid/watermark-lookup",
     "U",
-    "workspace.audit"
+    "entity.audit"
   ),
   // B11 assets and R2 (spec 05 §6.13). Bytes go to object storage through presigned URLs, never through the API. Writes are `Krw`, reads `Kr`;
   // share-link readers (`L`) are not built (no `/share/:token/assets` route yet). The uploader routes check the caller is the uploader.
   assetUploadCreate: r(
     "POST",
-    "/workspaces/:wid/assets/uploads",
+    "/entities/:wid/assets/uploads",
     "U,Krw",
     "assets.upload"
   ),
@@ -818,12 +818,7 @@ const API_ROUTES = {
     "U,Kr",
     "document.activity"
   ),
-  workspaceActivity: r(
-    "GET",
-    "/workspaces/:wid/activity",
-    "U",
-    "workspace.read"
-  ),
+  workspaceActivity: r("GET", "/entities/:wid/activity", "U", "entity.read"),
   notificationsList: r("GET", "/notifications", "U"),
   notificationsRead: r("POST", "/notifications/read", "U"),
   notificationDelete: r("DELETE", "/notifications/:nid", "U"),
@@ -844,9 +839,9 @@ const API_ROUTES = {
   meAiActivity: r("GET", "/me/ai-activity", "U"),
   workspaceAiActivity: r(
     "GET",
-    "/workspaces/:wid/ai-activity",
+    "/entities/:wid/ai-activity",
     "U",
-    "workspace.audit"
+    "entity.audit"
   ),
   aiEstimate: r("POST", "/documents/:did/ai/estimate", "U,Kr", "document.read"),
   aiReportsList: r(
@@ -874,6 +869,10 @@ const API_ROUTES = {
     "document.edit"
   ),
   consumablesBalance: r("GET", "/consumables/balance", "U,Kr"),
+  consumablesPurchaseTarget: r("POST", "/consumables/purchase-target", "U"),
+  consumablesRedeemCoupon: r("POST", "/consumables/redeem-coupon", "U"),
+  consumablesCouponsList: r("GET", "/consumables/coupons/history", "U"),
+  consumablesCouponsCreate: r("POST", "/consumables/coupons", "U"),
   consumablesPurchases: r("GET", "/consumables/purchases", "U"),
   consumablesUsages: r("GET", "/consumables/usages", "U"),
   consumablesProducts: r("GET", "/consumables/products", "U,Kr,P"),
@@ -899,7 +898,7 @@ const API_ROUTES = {
   adminJobKindUpdate: r("PATCH", "/admin/job-kinds/:kind", "U"),
   adminDocumentMeta: r("GET", "/admin/documents/:did/meta", "U")
 };
-const WORKSPACE_KINDS = ["personal", "team"];
+const ENTITY_KINDS = ["personal", "team"];
 const ROLES = [
   "owner",
   "admin",
@@ -907,16 +906,16 @@ const ROLES = [
   "commenter",
   "viewer"
 ];
-const workspaceKindSchema = z.enum(WORKSPACE_KINDS);
+const entityKindSchema = z.enum(ENTITY_KINDS);
 const roleSchema = z.enum(ROLES);
 const PERMISSION_MIN_ROLE = {
-  "workspace.read": "viewer",
-  "workspace.update": "admin",
-  "workspace.aiToggle": "owner",
-  "workspace.audit": "admin",
-  "workspace.delete": "owner",
-  "workspace.transfer": "owner",
-  "workspace.leave": "viewer",
+  "entity.read": "viewer",
+  "entity.update": "admin",
+  "entity.aiToggle": "owner",
+  "entity.audit": "admin",
+  "entity.delete": "owner",
+  "entity.transfer": "owner",
+  "entity.leave": "viewer",
   "members.read": "viewer",
   "members.invite": "admin",
   "members.updateRole": "admin",
@@ -986,11 +985,11 @@ const hasPermission = (role, permission) => roleAtLeast(role, PERMISSION_MIN_ROL
 const requiredRoleFor = (permission) => PERMISSION_MIN_ROLE[permission];
 const SHARE_ROLES = ["admin", "writer", "commenter", "viewer"];
 const TEAM_WORKSPACE_LIMIT = 50;
-const workspaceCreateSchema = z.object({
+const entityCreateSchema = z.object({
   name: z.string().trim().min(1).max(80),
   avatarAssetId: z.string().min(1).nullable().optional()
 });
-const workspaceUpdateSchema = z.object({
+const entityUpdateSchema = z.object({
   name: z.string().trim().min(1).max(80).optional(),
   avatarAssetId: z.string().min(1).nullable().optional(),
   defaultTemplateId: z.string().min(1).nullable().optional(),
@@ -998,11 +997,11 @@ const workspaceUpdateSchema = z.object({
   aiEnabled: z.boolean().optional(),
   allowPublicLinks: z.boolean().optional()
 });
-const workspaceDeleteSchema = z.object({ confirmName: z.string() });
-const workspaceTransferSchema = z.object({
+const entityDeleteSchema = z.object({ confirmName: z.string() });
+const entityTransferSchema = z.object({
   toUserId: z.string().min(1)
 });
-const workspaceAuditQuerySchema = z.object({
+const entityAuditQuerySchema = z.object({
   from: z.iso.datetime({ offset: true }).optional(),
   to: z.iso.datetime({ offset: true }).optional()
 });
@@ -1016,7 +1015,7 @@ const AUDIT_CSV_COLUMNS = [
 ];
 const AUDIT_MAX_RANGE_DAYS = 366;
 const memberUpdateSchema = z.object({ role: roleSchema });
-const INVITATION_TARGETS = ["workspace", "project", "document"];
+const INVITATION_TARGETS = ["entity", "project", "document"];
 const INVITATION_TTL_DAYS = 14;
 const INVITATION_STATUSES = [
   "pending",
@@ -1083,7 +1082,7 @@ const projectUpdateSchema = z.object({
   color: z.string().max(32).nullable().optional(),
   kind: projectKindSchema.optional(),
   logline: z.string().max(2e3).nullable().optional(),
-  workspaceId: z.string().optional()
+  entityId: z.string().optional()
 });
 const projectListQuerySchema = z.object({
   trashed: z.enum(["true", "false"]).transform((v) => v === "true").optional(),
@@ -1140,7 +1139,7 @@ const projectFolderDeleteQuerySchema = z.object({
 const projectPurgeSchema = z.object({ confirmName: z.string() });
 const projectDuplicateSchema = z.object({
   name: z.string().trim().min(1).max(200),
-  targetWorkspaceId: z.string().min(1).optional(),
+  targetEntityId: z.string().min(1).optional(),
   includeSnapshots: z.boolean().default(false),
   /** Re-links the source's asset links onto the copy (B11); a no-op when the target is a different workspace. */
   includeAssets: z.boolean().default(false)
@@ -1173,7 +1172,7 @@ const workspaceDocumentsQuerySchema = cursorQuerySchema.extend({
 const TRASH_ITEM_TYPES = ["project", "document", "asset"];
 const trashEmptySchema = z.object({ confirm: z.string() });
 const purgeInputSchema = z.object({
-  workspaceId: z.string().optional(),
+  entityId: z.string().optional(),
   projectId: z.string().optional(),
   documentId: z.string().optional()
 });
@@ -1227,7 +1226,7 @@ const workspaceContactsQuerySchema = cursorQuerySchema.extend({
 const projectDuplicateJobInputSchema = z.object({
   projectId: z.string().min(1),
   name: z.string().min(1),
-  targetWorkspaceId: z.string().min(1),
+  targetEntityId: z.string().min(1),
   includeSnapshots: z.boolean(),
   includeAssets: z.boolean()
 });
@@ -1459,8 +1458,8 @@ const documentViewStatePutSchema = documentViewStateSchema.extend({
 });
 const templateListQuerySchema = z.object({
   category: z.string().optional(),
-  workspaceId: z.string().optional(),
-  scope: z.enum(["builtin", "user", "workspace"]).optional(),
+  entityId: z.string().optional(),
+  scope: z.enum(["builtin", "user", "entity"]).optional(),
   locale: z.string().optional()
 });
 const templateGetQuerySchema = z.object({
@@ -1473,12 +1472,12 @@ const templateBody = z.custom(
   }
 );
 const templateCreateSchema = z.object({
-  scope: z.enum(["user", "workspace"]),
-  workspaceId: z.string().min(1).optional(),
+  scope: z.enum(["user", "entity"]),
+  entityId: z.string().min(1).optional(),
   template: templateBody
-}).refine((v) => v.scope !== "workspace" || !!v.workspaceId, {
-  message: "workspaceId is required for a workspace template",
-  path: ["workspaceId"]
+}).refine((v) => v.scope !== "entity" || !!v.entityId, {
+  message: "entityId is required for a workspace template",
+  path: ["entityId"]
 });
 const templateVersionCreateSchema = z.object({ template: templateBody });
 const templateUpdateSchema = z.object({
@@ -1494,13 +1493,13 @@ const TEMPLATE_FILE_FORMATS = [
 const FWTEMPLATE_FORMAT = "fadewright-template";
 const FWTEMPLATE_FORMAT_VERSION = 1;
 const templateImportSchema = z.object({
-  scope: z.enum(["user", "workspace"]),
-  workspaceId: z.string().min(1).optional(),
+  scope: z.enum(["user", "entity"]),
+  entityId: z.string().min(1).optional(),
   filename: z.string().min(1).max(255),
   contentB64: z.string().min(1)
-}).refine((v) => v.scope !== "workspace" || !!v.workspaceId, {
-  message: "workspaceId is required for a workspace template",
-  path: ["workspaceId"]
+}).refine((v) => v.scope !== "entity" || !!v.entityId, {
+  message: "entityId is required for a workspace template",
+  path: ["entityId"]
 });
 const templateImportByIdSchema = z.object({
   importId: z.string().min(1)
@@ -1719,7 +1718,7 @@ const SEARCH_HIT_TYPES = [
 const csv = (v) => typeof v === "string" ? v.split(",").map((s) => s.trim()).filter(Boolean) : v;
 const searchQuerySchema = cursorQuerySchema.extend({
   q: z.string().min(1).max(200),
-  workspaceId: z.string().min(1).optional(),
+  entityId: z.string().min(1).optional(),
   projectId: z.string().min(1).optional(),
   documentId: z.string().min(1).optional(),
   types: z.preprocess(csv, z.array(z.enum(SEARCH_HIT_TYPES)).min(1)).optional(),
@@ -1767,11 +1766,11 @@ const importFileFields = {
 const importCreateSchema = z.object({
   targetProjectId: z.string().min(1).optional(),
   templateTarget: z.object({
-    scope: z.enum(["user", "workspace"]),
-    workspaceId: z.string().min(1).optional()
-  }).refine((v) => v.scope !== "workspace" || !!v.workspaceId, {
-    message: "workspaceId is required for a workspace template",
-    path: ["workspaceId"]
+    scope: z.enum(["user", "entity"]),
+    entityId: z.string().min(1).optional()
+  }).refine((v) => v.scope !== "entity" || !!v.entityId, {
+    message: "entityId is required for a workspace template",
+    path: ["entityId"]
   }).optional(),
   ...importFileFields
 }).refine(
@@ -3409,7 +3408,7 @@ const linkedToSchema = z.string().regex(
   "linkedTo is <entity|scene|shot|element>:<id>"
 );
 const assetListQuerySchema = cursorQuerySchema.extend({
-  workspaceId: z.string().min(1).optional(),
+  entityId: z.string().min(1).optional(),
   documentId: z.string().min(1).optional(),
   linkedTo: linkedToSchema.optional(),
   role: assetRoleSchema.optional(),
@@ -4262,6 +4261,7 @@ export {
   DOCUMENT_LABEL_MAX_CHARS,
   DOCUMENT_VIEW_STATE_MAX_BYTES,
   ELEMENT_BATCH_MAX,
+  ENTITY_KINDS,
   ERROR_STATUS,
   EXPORT_CODE_PREFIX,
   EXPORT_FORMAT_IDS,
@@ -4358,7 +4358,6 @@ export {
   VERSION_REASONS,
   WORKSPACE_CONTACTS_BATCH_MAX,
   WORKSPACE_DEFAULTS_MAX_BYTES,
-  WORKSPACE_KINDS,
   WRITING_GOALS_MAX,
   WRITING_GOAL_KINDS,
   WRITING_STATS_GRANULARITIES,
@@ -4446,8 +4445,14 @@ export {
   elementHistoryQuerySchema,
   elementsBatchRequestSchema,
   encodeFrame,
+  entityAuditQuerySchema,
+  entityCreateSchema,
+  entityDeleteSchema,
   entityDialogueQuerySchema,
+  entityKindSchema,
   entityListQuerySchema,
+  entityTransferSchema,
+  entityUpdateSchema,
   entityUsageQuerySchema,
   epochChangedPayloadSchema,
   errorResponse,
@@ -4596,19 +4601,13 @@ export {
   watermarkLookupSchema,
   watermarkStyleSchema,
   workspaceActivityQuerySchema,
-  workspaceAuditQuerySchema,
   workspaceContactInputSchema,
   workspaceContactPatchSchema,
   workspaceContactsCreateSchema,
   workspaceContactsQuerySchema,
-  workspaceCreateSchema,
   workspaceDefaultsPutSchema,
   workspaceDefaultsSchema,
-  workspaceDeleteSchema,
   workspaceDocumentsQuerySchema,
-  workspaceKindSchema,
-  workspaceTransferSchema,
-  workspaceUpdateSchema,
   writingGoalInputSchema,
   writingGoalsPutSchema,
   writingSessionSchema,