@zmdb/web 1.0.0-beta.1

package/dist/contract/__fixtures__/http-convergence.d.ts

@@ -0,0 +1,396 @@
+interface UpdateMetadata {
+    readonly source: string;
+}
+interface UpdateAccountBody {
+    readonly displayName: string;
+    readonly metadata: UpdateMetadata | null;
+}
+interface Account {
+    readonly id: string;
+    readonly displayName: string;
+}
+interface AcceptedUpdate {
+    readonly jobId: string;
+}
+interface Problem {
+    readonly code: string;
+    readonly message: string;
+}
+interface UpdateAccountOperation {
+    readonly path: {
+        readonly accountId: string;
+    };
+    readonly query: {
+        readonly include?: readonly string[];
+        readonly dryRun?: boolean;
+    };
+    readonly headers: {
+        readonly requestId?: string;
+    };
+    readonly cookies: {
+        readonly session: string;
+    };
+    readonly body: UpdateAccountBody;
+    readonly responses: {
+        readonly 200: {
+            readonly body: Account;
+            readonly headers: {
+                readonly etag: string;
+            };
+        };
+        readonly 202: {
+            readonly body: AcceptedUpdate;
+        };
+        readonly 204: {
+            readonly body: void;
+        };
+        readonly 404: {
+            readonly body: Problem;
+        };
+    };
+}
+export declare class AccountsController {
+    update(): {
+        updated: boolean;
+    };
+}
+export declare const HTTP_CONTRACT: import("../index.js").HttpContractDeclaration<{
+    readonly patch_accounts_accountId: import("../index.js").HttpOperationDeclaration<UpdateAccountOperation, import("../index.js").HttpController, string>;
+}>;
+interface ReadSharedOperation {
+    readonly path: {
+        readonly id: string;
+    };
+    readonly responses: {
+        readonly 200: {
+            readonly body: Account;
+        };
+    };
+}
+interface WriteSharedOperation {
+    readonly path: {
+        readonly id: string;
+    };
+    readonly responses: {
+        readonly 202: {
+            readonly body: AcceptedUpdate;
+        };
+    };
+}
+export declare class SharedPathController {
+    read(): {
+        id: string;
+        displayName: string;
+    };
+    write(): {
+        jobId: string;
+    };
+}
+export declare const SHARED_PATH_CONTRACT: import("../index.js").HttpContractDeclaration<{
+    readonly post_shared_id: import("../index.js").HttpOperationDeclaration<WriteSharedOperation, import("../index.js").HttpController, string>;
+    readonly get_shared_id: import("../index.js").HttpOperationDeclaration<ReadSharedOperation, import("../index.js").HttpController, string>;
+}>;
+interface CollisionOperation {
+    readonly path: {
+        readonly id: string;
+    };
+    readonly responses: {
+        readonly 200: {
+            readonly body: Account;
+        };
+    };
+}
+export declare class CollisionController {
+    first(): {
+        id: string;
+        displayName: string;
+    };
+    second(): {
+        id: string;
+        displayName: string;
+    };
+}
+export declare const COLLIDING_ROUTE_CONTRACT: import("../index.js").HttpContractDeclaration<{
+    readonly z_collision_first: import("../index.js").HttpOperationDeclaration<CollisionOperation, import("../index.js").HttpController, string>;
+    readonly a_collision_second: import("../index.js").HttpOperationDeclaration<CollisionOperation, import("../index.js").HttpController, string>;
+}>;
+export declare class DynamicController {
+    read(): {
+        id: string;
+        displayName: string;
+    };
+}
+export declare const DYNAMIC_METADATA_CONTRACT: import("../index.js").HttpContractDeclaration<{
+    readonly get_dynamic_id: import("../index.js").HttpOperationDeclaration<CollisionOperation, import("../index.js").HttpController, string>;
+}>;
+export declare const REQUEST_BODY_SCHEMA: {
+    type: string;
+    required: string[];
+    properties: {
+        displayName: {
+            type: string;
+        };
+        metadata: {
+            type: string[];
+            additionalProperties: true;
+        };
+    };
+};
+export declare const SUCCESS_BODY_SCHEMA: {
+    type: string;
+    required: string[];
+    properties: {
+        id: {
+            type: string;
+        };
+        displayName: {
+            type: string;
+        };
+    };
+};
+export declare const HTTP_CONVERGENCE_FIXTURE: {
+    readonly contract: {
+        format: 1;
+        types: {
+            'patch_accounts_accountId/parameter/path/accountId': {
+                type: import("@zmdb/schema/ir").ScalarIR;
+                openApi: {
+                    type: string;
+                };
+            };
+            'patch_accounts_accountId/parameter/query/include': {
+                type: import("@zmdb/schema/ir").ArrayIR;
+                openApi: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+            'patch_accounts_accountId/parameter/query/dryRun': {
+                type: import("@zmdb/schema/ir").ScalarIR;
+                openApi: {
+                    type: string;
+                };
+            };
+            'patch_accounts_accountId/parameter/header/requestId': {
+                type: import("@zmdb/schema/ir").ScalarIR;
+                openApi: {
+                    type: string;
+                };
+            };
+            'patch_accounts_accountId/parameter/cookie/session': {
+                type: import("@zmdb/schema/ir").ScalarIR;
+                openApi: {
+                    type: string;
+                };
+            };
+            'patch_accounts_accountId/request/body': {
+                type: import("@zmdb/schema/ir").ObjectIR;
+                openApi: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        displayName: {
+                            type: string;
+                        };
+                        metadata: {
+                            type: string[];
+                            additionalProperties: true;
+                        };
+                    };
+                };
+            };
+            'patch_accounts_accountId/response/200/body': {
+                type: import("@zmdb/schema/ir").ObjectIR;
+                openApi: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        displayName: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            'patch_accounts_accountId/response/200/header/etag': {
+                type: import("@zmdb/schema/ir").ScalarIR;
+                openApi: {
+                    type: string;
+                };
+            };
+            'patch_accounts_accountId/response/202/body': {
+                type: import("@zmdb/schema/ir").ObjectIR;
+                openApi: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        jobId: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            'patch_accounts_accountId/response/404/body': {
+                type: import("@zmdb/schema/ir").ObjectIR;
+                openApi: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        code: {
+                            type: string;
+                        };
+                        message: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+        operations: [{
+            operationId: "patch_accounts_accountId";
+            controller: "AccountsController";
+            handler: "update";
+            method: "PATCH";
+            path: "/accounts/:accountId";
+            parameters: ({
+                property: string;
+                name: string;
+                in: "path";
+                required: true;
+                typeId: string;
+            } | {
+                property: string;
+                name: string;
+                in: "query";
+                required: false;
+                typeId: string;
+            } | {
+                property: string;
+                name: string;
+                in: "header";
+                required: false;
+                typeId: string;
+            } | {
+                property: string;
+                name: string;
+                in: "cookie";
+                required: true;
+                typeId: string;
+            })[];
+            requestBody: {
+                kind: "json";
+                mediaType: "application/json";
+                typeId: "patch_accounts_accountId/request/body";
+                required: true;
+            };
+            responses: ({
+                status: number;
+                description: string;
+                headers: {
+                    property: string;
+                    name: string;
+                    required: true;
+                    typeId: string;
+                }[];
+                body: {
+                    kind: "json";
+                    mediaType: string;
+                    typeId: string;
+                };
+            } | {
+                status: number;
+                description: string;
+                headers: never[];
+                body: {
+                    mediaType?: never;
+                    typeId?: never;
+                    kind: "empty";
+                };
+            })[];
+            security: [{
+                bearerAuth: never[];
+            }, {
+                apiKeyAuth: never[];
+            }];
+            version: {
+                kind: "header";
+                name: "accept-version";
+                values: ["1", "2"];
+                default: "1";
+            };
+            deprecated: true;
+        }];
+        securitySchemes: {
+            bearerAuth: {
+                type: "http";
+                scheme: "bearer";
+            };
+            apiKeyAuth: {
+                type: "apiKey";
+                in: "header";
+                name: "x-api-key";
+            };
+        };
+    };
+    readonly input: {
+        readonly path: {
+            readonly accountId: 'acct/blue?draft#1';
+        };
+        readonly query: {
+            readonly include: readonly ['roles & permissions', 'teams'];
+            readonly dryRun: undefined;
+        };
+        readonly headers: {
+            readonly requestId: 'request-680';
+        };
+        readonly cookies: {
+            readonly session: 'session value';
+        };
+        readonly body: {
+            readonly displayName: 'Ada';
+            readonly metadata: null;
+        };
+    };
+    readonly expectedRequest: {
+        readonly path: '/accounts/acct%2Fblue%3Fdraft%231';
+        readonly query: readonly [{
+            readonly name: 'include';
+            readonly value: 'roles & permissions';
+        }, {
+            readonly name: 'include';
+            readonly value: 'teams';
+        }];
+        readonly headers: {
+            readonly 'x-request-id': 'request-680';
+        };
+        readonly cookies: readonly [{
+            readonly name: 'session';
+            readonly value: 'session value';
+        }];
+        readonly body: '{"displayName":"Ada","metadata":null}';
+        readonly version: '2';
+    };
+    readonly bodyKinds: readonly [{
+        readonly kind: 'json';
+        readonly mediaType: 'application/json';
+    }, {
+        readonly kind: 'text';
+        readonly mediaType: 'text/plain';
+    }, {
+        readonly kind: 'bytes';
+        readonly mediaType: 'application/octet-stream';
+    }, {
+        readonly kind: 'stream';
+        readonly mediaType: 'application/x-ndjson';
+    }, {
+        readonly kind: 'empty';
+    }];
+};
+export type FrozenHttpContract = typeof HTTP_CONVERGENCE_FIXTURE.contract;
+export type FrozenHttpOperation = FrozenHttpContract['operations'][number];
+export {};
+//# sourceMappingURL=http-convergence.d.ts.map

package/dist/contract/__fixtures__/http-convergence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-convergence.d.ts","sourceRoot":"","sources":["../../../src/contract/__fixtures__/http-convergence.ts"],"names":[],"mappings":"AAMA,UAAU,cAAc;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,iBAAiB;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;CAC1C;AAED,UAAU,OAAO;IACf,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,UAAU,cAAc;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,OAAO;IACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,sBAAsB;IAC9B,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACpF,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClD,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE;QAClB,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;YAAC,QAAQ,CAAC,OAAO,EAAE;gBAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;QACtF,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;SAAE,CAAC;QAChD,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;SAAE,CAAC;QACtC,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;SAAE,CAAC;KAC1C,CAAC;CACH;AAED,qBAEa,kBAAkB;IAE7B,MAAM;QACK,OAAO;MACjB;CACF;AAED,eAAO,MAAM,aAAa;;EAgDxB,CAAC;AAEH,UAAU,mBAAmB;IAC3B,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,CAAC;CAClE;AAED,UAAU,oBAAoB;IAC5B,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;SAAE,CAAA;KAAE,CAAC;CACzE;AAED,qBACa,oBAAoB;IAG/B,IAAI;QACO,EAAE;QAAY,WAAW;MACnC;IAID,KAAK;QACM,KAAK;MACf;CACF;AAED,eAAO,MAAM,oBAAoB;;;EAoC/B,CAAC;AAEH,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE;YAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,CAAC;CAClE;AAED,qBACa,mBAAmB;IAG9B,KAAK;QACM,EAAE;QAAW,WAAW;MAClC;IAID,MAAM;QACK,EAAE;QAAY,WAAW;MACnC;CACF;AAED,eAAO,MAAM,wBAAwB;;;EA8BnC,CAAC;AAIH,qBACa,iBAAiB;IAG5B,IAAI;QACO,EAAE;QAAa,WAAW;MACpC;CACF;AAED,eAAO,MAAM,yBAAyB;;EAiBpC,CAAC;AA6GH,eAAO,MAAM,mBAAmB;;;;;YAIb,IAAI;;;;;;;CAGwB,CAAC;AAEhD,eAAO,MAAM,mBAAmB;;;;QAI5B,EAAE;YAAI,IAAI;;QACV,WAAW;YAAI,IAAI;;;CAEwB,CAAC;AAEhD,eAAO,MAAM,wBAAwB;;;;YAI/B,mDAAmD;gBACjD,IAAI;gBACJ,OAAO;oBAAI,IAAI;;;YAEjB,kDAAkD;gBAChD,IAAI;gBACJ,OAAO;oBAAI,IAAI;oBAAW,KAAK;wBAAI,IAAI;;;;YAEzC,iDAAiD;gBAC/C,IAAI;gBACJ,OAAO;oBAAI,IAAI;;;YAEjB,qDAAqD;gBACnD,IAAI;gBACJ,OAAO;oBAAI,IAAI;;;YAEjB,mDAAmD;gBACjD,IAAI;gBACJ,OAAO;oBAAI,IAAI;;;YAEjB,uCAAuC;gBACrC,IAAI;gBACJ,OAAO;;;;;4BAxCI,IAAI;;;;;;;;;YA0CjB,4CAA4C;gBAC1C,IAAI;gBACJ,OAAO;;;;wBAnCX,EAAE;4BAAI,IAAI;;wBACV,WAAW;4BAAI,IAAI;;;;;YAoCjB,mDAAmD;gBACjD,IAAI;gBACJ,OAAO;oBAAI,IAAI;;;YAEjB,4CAA4C;gBAC1C,IAAI;gBACJ,OAAO;oBACL,IAAI;oBACJ,QAAQ;oBACR,UAAU;wBAAI,KAAK;4BAAI,IAAI;;;;;YAG/B,4CAA4C;gBAC1C,IAAI;gBACJ,OAAO;oBACL,IAAI;oBACJ,QAAQ;oBACR,UAAU;wBAAI,IAAI;4BAAI,IAAI;;wBAAc,OAAO;4BAAI,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmH7D,IAAI;qBAAI,SAAS,EAAE,mBAAmB;;iBACtC,KAAK;qBAAI,OAAO,YAAG,qBAAqB,EAAE,OAAO;qBAAG,MAAM;;iBAC1D,OAAO;qBAAI,SAAS,EAAE,aAAa;;iBACnC,OAAO;qBAAI,OAAO,EAAE,eAAe;;iBACnC,IAAI;qBAAI,WAAW,EAAE,KAAK;qBAAE,QAAQ;;;;iBAGpC,IAAI,EAAE,mCAAmC;iBACzC,KAAK;qBACD,IAAI,EAAE,SAAS;qBAAE,KAAK,EAAE,qBAAqB;;qBAC7C,IAAI,EAAE,SAAS;qBAAE,KAAK,EAAE,OAAO;;iBAEnC,OAAO;qBAAI,cAAc,EAAE,aAAa;;iBACxC,OAAO;qBAAK,IAAI,EAAE,SAAS;qBAAE,KAAK,EAAE,eAAe;;iBACnD,IAAI,EAAE,uCAAuC;iBAC7C,OAAO,EAAE,GAAG;;;iBAGV,IAAI,EAAE,MAAM;iBAAE,SAAS,EAAE,kBAAkB;;iBAC3C,IAAI,EAAE,MAAM;iBAAE,SAAS,EAAE,YAAY;;iBACrC,IAAI,EAAE,OAAO;iBAAE,SAAS,EAAE,0BAA0B;;iBACpD,IAAI,EAAE,QAAQ;iBAAE,SAAS,EAAE,sBAAsB;;iBACjD,IAAI,EAAE,OAAO;;CAET,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,OAAO,wBAAwB,CAAC,QAAQ,CAAC;AAC1E,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC"}