@sudobility/screenwriter_types 0.1.5 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/envelope.d.ts +1 -1
- package/dist/api/routes.d.ts +5 -0
- package/dist/credits/index.d.ts +24 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/api/envelope.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Platform-free: no clock is read here, so the envelope carries no timestamp.
|
|
4
4
|
*/
|
|
5
5
|
/** Every REST error code and its fixed HTTP status (spec 05 §12). */
|
|
6
|
-
declare const ERROR_TABLE: readonly [readonly ["UNAUTHORIZED", 401], readonly ["REAUTH_REQUIRED", 401], readonly ["API_KEY_FORBIDDEN", 403], readonly ["FORBIDDEN", 403], readonly ["ROLE_ESCALATION", 403], readonly ["NOT_FOUND", 404], readonly ["PROJECT_NOT_FOUND", 404], readonly ["DOCUMENT_NOT_FOUND", 404], readonly ["SNAPSHOT_NOT_FOUND", 404], readonly ["TEMPLATE_NOT_FOUND", 404], readonly ["ITEM_NOT_FOUND", 404], readonly ["ANCHOR_NOT_FOUND", 404], readonly ["TARGET_NOT_FOUND", 404], readonly ["VALIDATION", 400], readonly ["COMMAND_INVALID", 422], readonly ["TEMPLATE_INVALID", 422], readonly ["CONFIRMATION_MISMATCH", 400], readonly ["EPOCH_MISMATCH", 409], readonly ["DOCUMENT_LOCKED", 423], readonly ["DOCUMENT_BUSY", 409], readonly ["JOB_ALREADY_RUNNING", 409], readonly ["JOB_FINISHED", 409], readonly ["JOB_NOT_FINISHED", 409], readonly ["LAST_OWNER", 409], readonly ["ALREADY_MEMBER", 409], readonly ["NOT_A_MEMBER", 409], readonly ["PERSONAL_WORKSPACE_IMMUTABLE", 409], readonly ["OWNS_TEAM_WORKSPACE", 409], readonly ["NOT_IN_TRASH", 409], readonly ["PARENT_IN_TRASH", 409], readonly ["FOLDER_DEPTH", 409], readonly ["FOLDER_CYCLE", 409], readonly ["MOVE_FORBIDDEN", 403], readonly ["BUILTIN_IMMUTABLE", 409], readonly ["LOCATOR_AMBIGUOUS", 409], readonly ["INVITATION_INVALID", 410], readonly ["INVITATION_EXPIRED", 410], readonly ["INVITATION_CLOSED", 410], readonly ["EMAIL_MISMATCH", 403], readonly ["SHARE_LINK_INVALID", 404], readonly ["SHARE_LINK_PASSWORD_REQUIRED", 401], readonly ["WATERMARK_REQUIRED", 403], readonly ["EDIT_WINDOW_CLOSED", 409], readonly ["ASSET_TOO_LARGE", 413], readonly ["IMPORT_TOO_LARGE", 413], readonly ["UNSUPPORTED_FORMAT", 400], readonly ["IMPORT_FAILED", 400], readonly ["IMPORT_INVALID", 422], readonly ["ASSET_TYPE_REJECTED", 415], readonly ["ASSET_CHECKSUM_MISMATCH", 422], readonly ["ASSET_NOT_READY", 409], readonly ["ASSET_IN_USE", 409], readonly ["UPLOAD_INCOMPLETE", 409], readonly ["UPLOAD_EXPIRED", 410], readonly ["STORAGE_QUOTA_EXCEEDED", 507], readonly ["STORAGE_UNAVAILABLE", 503], readonly ["IMPORT_FORMAT_UNSUPPORTED", 415], readonly ["EXPORT_FORMAT_UNSUPPORTED", 415], readonly ["COMPARE_TOO_LARGE", 413], readonly ["LIMIT_EXCEEDED", 409], readonly ["RATE_LIMITED", 429], readonly ["QUOTA_EXCEEDED", 429], readonly ["INSUFFICIENT_CREDITS", 402], readonly ["AI_UNAVAILABLE", 503], readonly ["AI_INPUT_TOO_LARGE", 413], readonly ["AI_GENERATION_FAILED", 502], readonly ["AI_OUTPUT_INVALID", 502], readonly ["CONFIG_MISSING", 503], readonly ["CLIENT_TOO_OLD", 426], readonly ["CONTENT_CHANGED", 409], readonly ["STYLE_NOT_IN_TEMPLATE", 422], readonly ["NOT_CONTIGUOUS", 422], readonly ["LOCKED_CONTENT", 409], readonly ["NAME_COLLISION", 409], readonly ["KIND_MISMATCH", 422], readonly ["OVERLAPPING_SHOTS", 422], readonly ["OVERLAPPING_NODE", 422], readonly ["SCENES_LOCKED", 409], readonly ["NOT_LOCKED", 409], readonly ["RANGE_OUT_OF_BOUNDS", 422], readonly ["INVALID_TARGET", 422], readonly ["INVALID_DUAL_DIALOGUE", 422], readonly ["FOUNTAIN_PARSE_ERROR", 422], readonly ["UNMAPPED_STYLES", 422], readonly ["RANGE_TOO_LARGE", 413], readonly ["PAYLOAD_TOO_LARGE", 413], readonly ["INVALID_REGEX", 400], readonly ["REPORT_OPTIONS_INVALID", 400], readonly ["REPORT_KIND_UNAVAILABLE", 501], readonly ["ENTITY_IN_USE", 409], readonly ["VARIANT_IN_USE", 409], readonly ["SNAPSHOT_NOT_IN_DOCUMENT", 404], readonly ["ITEM_NOT_IN_SNAPSHOT", 404], readonly ["INVALID_LOCATOR", 400], readonly ["LOCATOR_NOT_FOUND", 404], readonly ["ROLE_NOT_ALLOWED_FOR_TARGET", 422], readonly ["ID_CONFLICT", 409], readonly ["IDEMPOTENCY_KEY_REUSED", 409], readonly ["IDEMPOTENCY_IN_PROGRESS", 409], readonly ["DEVICE_REVOKED", 403], readonly ["MACRO_TRIGGER_TAKEN", 409], readonly ["STALE_WRITE", 409], readonly ["HANDOFF_INVALID", 410], readonly ["WATERMARK_NOT_FOUND", 404], readonly ["OCR_UNAVAILABLE", 503], readonly ["GRAMMAR_UNAVAILABLE", 503], readonly ["AI_CONSENT_REQUIRED", 403], readonly ["AI_DISABLED_FOR_WORKSPACE", 403], readonly ["AI_EXCLUDED_DOCUMENT", 403], readonly ["AI_KEY_NOT_PERMITTED", 403], readonly ["QUOTE_EXCEEDS_MAX", 402], readonly ["AI_CONTENT_REFUSED", 422], readonly ["SCOPE_TOO_LARGE", 413], readonly ["SUGGESTION_UNAVAILABLE", 409], readonly ["JOB_KIND_DISABLED", 501], readonly ["JOB_KIND_NOT_GENERIC", 400], readonly ["JOB_FAILED", 409], readonly ["JOB_TIMEOUT", 504], readonly ["LIKENESS_CONSENT_REQUIRED", 422], readonly ["CONTENT_REJECTED", 422], readonly ["INTERNAL", 500]];
|
|
6
|
+
declare const ERROR_TABLE: readonly [readonly ["UNAUTHORIZED", 401], readonly ["REAUTH_REQUIRED", 401], readonly ["API_KEY_FORBIDDEN", 403], readonly ["FORBIDDEN", 403], readonly ["ROLE_ESCALATION", 403], readonly ["NOT_FOUND", 404], readonly ["PROJECT_NOT_FOUND", 404], readonly ["DOCUMENT_NOT_FOUND", 404], readonly ["SNAPSHOT_NOT_FOUND", 404], readonly ["TEMPLATE_NOT_FOUND", 404], readonly ["ITEM_NOT_FOUND", 404], readonly ["ANCHOR_NOT_FOUND", 404], readonly ["TARGET_NOT_FOUND", 404], readonly ["VALIDATION", 400], readonly ["COMMAND_INVALID", 422], readonly ["TEMPLATE_INVALID", 422], readonly ["CONFIRMATION_MISMATCH", 400], readonly ["EPOCH_MISMATCH", 409], readonly ["DOCUMENT_LOCKED", 423], readonly ["DOCUMENT_BUSY", 409], readonly ["JOB_ALREADY_RUNNING", 409], readonly ["JOB_FINISHED", 409], readonly ["JOB_NOT_FINISHED", 409], readonly ["LAST_OWNER", 409], readonly ["ALREADY_MEMBER", 409], readonly ["NOT_A_MEMBER", 409], readonly ["PERSONAL_WORKSPACE_IMMUTABLE", 409], readonly ["OWNS_TEAM_WORKSPACE", 409], readonly ["NOT_IN_TRASH", 409], readonly ["PARENT_IN_TRASH", 409], readonly ["FOLDER_DEPTH", 409], readonly ["FOLDER_CYCLE", 409], readonly ["MOVE_FORBIDDEN", 403], readonly ["BUILTIN_IMMUTABLE", 409], readonly ["LOCATOR_AMBIGUOUS", 409], readonly ["INVITATION_INVALID", 410], readonly ["INVITATION_EXPIRED", 410], readonly ["INVITATION_CLOSED", 410], readonly ["EMAIL_MISMATCH", 403], readonly ["SHARE_LINK_INVALID", 404], readonly ["SHARE_LINK_PASSWORD_REQUIRED", 401], readonly ["WATERMARK_REQUIRED", 403], readonly ["EDIT_WINDOW_CLOSED", 409], readonly ["ASSET_TOO_LARGE", 413], readonly ["IMPORT_TOO_LARGE", 413], readonly ["UNSUPPORTED_FORMAT", 400], readonly ["IMPORT_FAILED", 400], readonly ["IMPORT_INVALID", 422], readonly ["ASSET_TYPE_REJECTED", 415], readonly ["ASSET_CHECKSUM_MISMATCH", 422], readonly ["ASSET_NOT_READY", 409], readonly ["ASSET_IN_USE", 409], readonly ["UPLOAD_INCOMPLETE", 409], readonly ["UPLOAD_EXPIRED", 410], readonly ["STORAGE_QUOTA_EXCEEDED", 507], readonly ["STORAGE_UNAVAILABLE", 503], readonly ["IMPORT_FORMAT_UNSUPPORTED", 415], readonly ["EXPORT_FORMAT_UNSUPPORTED", 415], readonly ["COMPARE_TOO_LARGE", 413], readonly ["LIMIT_EXCEEDED", 409], readonly ["RATE_LIMITED", 429], readonly ["QUOTA_EXCEEDED", 429], readonly ["INSUFFICIENT_CREDITS", 402], readonly ["COUPON_NOT_FOUND", 404], readonly ["COUPON_EMAIL_MISMATCH", 403], readonly ["COUPON_ALREADY_REDEEMED", 409], readonly ["COUPON_EXPIRED", 410], readonly ["AI_UNAVAILABLE", 503], readonly ["AI_INPUT_TOO_LARGE", 413], readonly ["AI_GENERATION_FAILED", 502], readonly ["AI_OUTPUT_INVALID", 502], readonly ["CONFIG_MISSING", 503], readonly ["CLIENT_TOO_OLD", 426], readonly ["CONTENT_CHANGED", 409], readonly ["STYLE_NOT_IN_TEMPLATE", 422], readonly ["NOT_CONTIGUOUS", 422], readonly ["LOCKED_CONTENT", 409], readonly ["NAME_COLLISION", 409], readonly ["KIND_MISMATCH", 422], readonly ["OVERLAPPING_SHOTS", 422], readonly ["OVERLAPPING_NODE", 422], readonly ["SCENES_LOCKED", 409], readonly ["NOT_LOCKED", 409], readonly ["RANGE_OUT_OF_BOUNDS", 422], readonly ["INVALID_TARGET", 422], readonly ["INVALID_DUAL_DIALOGUE", 422], readonly ["FOUNTAIN_PARSE_ERROR", 422], readonly ["UNMAPPED_STYLES", 422], readonly ["RANGE_TOO_LARGE", 413], readonly ["PAYLOAD_TOO_LARGE", 413], readonly ["INVALID_REGEX", 400], readonly ["REPORT_OPTIONS_INVALID", 400], readonly ["REPORT_KIND_UNAVAILABLE", 501], readonly ["ENTITY_IN_USE", 409], readonly ["VARIANT_IN_USE", 409], readonly ["SNAPSHOT_NOT_IN_DOCUMENT", 404], readonly ["ITEM_NOT_IN_SNAPSHOT", 404], readonly ["INVALID_LOCATOR", 400], readonly ["LOCATOR_NOT_FOUND", 404], readonly ["ROLE_NOT_ALLOWED_FOR_TARGET", 422], readonly ["ID_CONFLICT", 409], readonly ["IDEMPOTENCY_KEY_REUSED", 409], readonly ["IDEMPOTENCY_IN_PROGRESS", 409], readonly ["DEVICE_REVOKED", 403], readonly ["MACRO_TRIGGER_TAKEN", 409], readonly ["STALE_WRITE", 409], readonly ["HANDOFF_INVALID", 410], readonly ["WATERMARK_NOT_FOUND", 404], readonly ["OCR_UNAVAILABLE", 503], readonly ["GRAMMAR_UNAVAILABLE", 503], readonly ["AI_CONSENT_REQUIRED", 403], readonly ["AI_DISABLED_FOR_WORKSPACE", 403], readonly ["AI_EXCLUDED_DOCUMENT", 403], readonly ["AI_KEY_NOT_PERMITTED", 403], readonly ["QUOTE_EXCEEDS_MAX", 402], readonly ["AI_CONTENT_REFUSED", 422], readonly ["SCOPE_TOO_LARGE", 413], readonly ["SUGGESTION_UNAVAILABLE", 409], readonly ["JOB_KIND_DISABLED", 501], readonly ["JOB_KIND_NOT_GENERIC", 400], readonly ["JOB_FAILED", 409], readonly ["JOB_TIMEOUT", 504], readonly ["LIKENESS_CONSENT_REQUIRED", 422], readonly ["CONTENT_REJECTED", 422], readonly ["INTERNAL", 500]];
|
|
7
7
|
type ErrorTable = typeof ERROR_TABLE;
|
|
8
8
|
export type ApiErrorCode = ErrorTable[number][0];
|
|
9
9
|
export declare const API_ERROR_CODES: { readonly [C in ApiErrorCode]: C; };
|
package/dist/api/routes.d.ts
CHANGED
|
@@ -99,6 +99,7 @@ export declare const API_ROUTES: {
|
|
|
99
99
|
readonly invitationRenew: RouteSpec;
|
|
100
100
|
readonly invitationCancel: RouteSpec;
|
|
101
101
|
readonly invitationAccept: RouteSpec;
|
|
102
|
+
readonly invitationAcceptById: RouteSpec;
|
|
102
103
|
readonly invitationDecline: RouteSpec;
|
|
103
104
|
readonly sharedWithMe: RouteSpec;
|
|
104
105
|
readonly documentLock: RouteSpec;
|
|
@@ -252,6 +253,10 @@ export declare const API_ROUTES: {
|
|
|
252
253
|
readonly aiReportNoteConvert: RouteSpec;
|
|
253
254
|
readonly aiSuggestionSetDecide: RouteSpec;
|
|
254
255
|
readonly consumablesBalance: RouteSpec;
|
|
256
|
+
readonly consumablesPurchaseTarget: RouteSpec;
|
|
257
|
+
readonly consumablesRedeemCoupon: RouteSpec;
|
|
258
|
+
readonly consumablesCouponsList: RouteSpec;
|
|
259
|
+
readonly consumablesCouponsCreate: RouteSpec;
|
|
255
260
|
readonly consumablesPurchases: RouteSpec;
|
|
256
261
|
readonly consumablesUsages: RouteSpec;
|
|
257
262
|
readonly consumablesProducts: RouteSpec;
|
package/dist/credits/index.d.ts
CHANGED
|
@@ -24,3 +24,27 @@ export interface PurchaseHandoffResponse {
|
|
|
24
24
|
handoffUrl: string;
|
|
25
25
|
expiresAt: string;
|
|
26
26
|
}
|
|
27
|
+
export interface CreditCouponHistoryItem {
|
|
28
|
+
workspaceId: string;
|
|
29
|
+
userId: string;
|
|
30
|
+
credits: number;
|
|
31
|
+
redeemedAt: string;
|
|
32
|
+
}
|
|
33
|
+
export interface CreditCoupon {
|
|
34
|
+
id: string;
|
|
35
|
+
code: string;
|
|
36
|
+
credits: number;
|
|
37
|
+
expiresAt: string;
|
|
38
|
+
email: string | null;
|
|
39
|
+
createdAt: string;
|
|
40
|
+
history: CreditCouponHistoryItem[];
|
|
41
|
+
}
|
|
42
|
+
export interface CreditCouponCreateRequest {
|
|
43
|
+
credits: number;
|
|
44
|
+
expires_at: string;
|
|
45
|
+
email?: string | null;
|
|
46
|
+
}
|
|
47
|
+
export interface CreditCouponRedeemResponse {
|
|
48
|
+
credits: number;
|
|
49
|
+
balance: number;
|
|
50
|
+
}
|
package/dist/index.js
CHANGED
|
@@ -66,6 +66,10 @@ const ERROR_TABLE = [
|
|
|
66
66
|
["RATE_LIMITED", 429],
|
|
67
67
|
["QUOTA_EXCEEDED", 429],
|
|
68
68
|
["INSUFFICIENT_CREDITS", 402],
|
|
69
|
+
["COUPON_NOT_FOUND", 404],
|
|
70
|
+
["COUPON_EMAIL_MISMATCH", 403],
|
|
71
|
+
["COUPON_ALREADY_REDEEMED", 409],
|
|
72
|
+
["COUPON_EXPIRED", 410],
|
|
69
73
|
["AI_UNAVAILABLE", 503],
|
|
70
74
|
["AI_INPUT_TOO_LARGE", 413],
|
|
71
75
|
["AI_GENERATION_FAILED", 502],
|
|
@@ -433,6 +437,7 @@ const API_ROUTES = {
|
|
|
433
437
|
invitationRenew: r("POST", "/invitations/:iid/renew", "U"),
|
|
434
438
|
invitationCancel: r("DELETE", "/invitations/:iid", "U"),
|
|
435
439
|
invitationAccept: r("POST", "/invitations/accept", "U"),
|
|
440
|
+
invitationAcceptById: r("POST", "/invitations/:iid/accept", "U"),
|
|
436
441
|
invitationDecline: r("POST", "/invitations/:iid/decline", "U"),
|
|
437
442
|
sharedWithMe: r("GET", "/me/shared", "U,Kr"),
|
|
438
443
|
documentLock: r("POST", "/documents/:did/lock", "U", "document.lock"),
|
|
@@ -874,6 +879,10 @@ const API_ROUTES = {
|
|
|
874
879
|
"document.edit"
|
|
875
880
|
),
|
|
876
881
|
consumablesBalance: r("GET", "/consumables/balance", "U,Kr"),
|
|
882
|
+
consumablesPurchaseTarget: r("POST", "/consumables/purchase-target", "U"),
|
|
883
|
+
consumablesRedeemCoupon: r("POST", "/consumables/redeem-coupon", "U"),
|
|
884
|
+
consumablesCouponsList: r("GET", "/consumables/coupons/history", "U"),
|
|
885
|
+
consumablesCouponsCreate: r("POST", "/consumables/coupons", "U"),
|
|
877
886
|
consumablesPurchases: r("GET", "/consumables/purchases", "U"),
|
|
878
887
|
consumablesUsages: r("GET", "/consumables/usages", "U"),
|
|
879
888
|
consumablesProducts: r("GET", "/consumables/products", "U,Kr,P"),
|