@lix-js/sdk 0.0.1

package/node_modules/@lix-js/server-api-schema/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+	"useTabs": true
+}

package/node_modules/@lix-js/server-api-schema/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["42crunch.vscode-openapi"]
+}

package/node_modules/@lix-js/server-api-schema/dist/schema.d.ts

@@ -0,0 +1,384 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/lsa/new-v1": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Stores the lix on the server.
+         * @description Use sync if you want to push or pull data from the server.
+         *
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            /** @description The lix binary. */
+            requestBody: {
+                content: {
+                    "application/octet-stream": unknown;
+                };
+            };
+            responses: {
+                /** @description Lix file created successfully. */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description The ID of the created lix.
+                             * @example 123e4567-e89b-12d3-a456-426614174000
+                             */
+                            id?: string;
+                        };
+                    };
+                };
+                /** @description Invalid Lix file. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error message.
+                             * @example Invalid Lix file.
+                             */
+                            error?: string;
+                        };
+                    };
+                };
+                /** @description Lix file already exists. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error message.
+                             * @example Lix file already exists.
+                             */
+                            error?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/lsa/get-v1": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Get the lix from the server. */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The ID of the lix to get.
+                         * @example 123e4567-e89b-12d3-a456-426614174000
+                         */
+                        lix_id: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Lix file fetched successfully. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/octet-stream": unknown;
+                    };
+                };
+                /** @description Lix file not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error message.
+                             * @example Lix file not found.
+                             */
+                            error?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/lsa/push-v1": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Push data to the server. */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The ID of the lix to push to.
+                         * @example 123e4567-e89b-12d3-a456-426614174000
+                         */
+                        lix_id: string;
+                        vector_clock: {
+                            /**
+                             * @description The session ID of the client.
+                             * @example 123e4567-e
+                             */
+                            session: string;
+                            /**
+                             * @description The time of the client.
+                             * @example 123456789
+                             */
+                            time: number;
+                        }[];
+                        /**
+                         * @description The data to push.
+                         * @example {
+                         *       "table_name": [
+                         *       {
+                         *         "id": 1,
+                         *         "name": "Alice"
+                         *       }
+                         *       ]
+                         *     }
+                         *
+                         */
+                        data: {
+                            [key: string]: {
+                                [key: string]: unknown;
+                            }[];
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description Rows pushed successfully. */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Invalid row data. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description A machine-readable error code.
+                             * @example INVALID_ROW_DATA
+                             */
+                            code?: string;
+                            /**
+                             * @description A human-readable error message.
+                             * @example The provided row data is invalid.
+                             */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Lix not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Server error. */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Error message.
+                             * @example INTERNAL_SERVER_ERROR
+                             */
+                            code?: string;
+                            /**
+                             * @description A human-readable error message.
+                             * @example An internal server error occurred.
+                             */
+                            message?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/lsa/pull-v1": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Pull all data for all tables from the server. */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The ID of the lix to pull from.
+                         * @example 123e4567-e89b-12d3-a456-426614174000
+                         */
+                        lix_id: string;
+                        vector_clock: {
+                            /**
+                             * @description The session ID of the client.
+                             * @example 123e4567-e
+                             */
+                            session: string;
+                            /**
+                             * @description The time of the client.
+                             * @example 123456789
+                             */
+                            time: number;
+                        }[];
+                    };
+                };
+            };
+            responses: {
+                /** @description Data fetched successfully. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            vector_clock: {
+                                /**
+                                 * @description The session ID of the server.
+                                 * @example 123e4567-e
+                                 */
+                                session: string;
+                                /** @description The time of the server. */
+                                time: number;
+                            }[];
+                            /**
+                             * @description The data to push.
+                             * @example {
+                             *       "table_name": [
+                             *       {
+                             *         "id": 1,
+                             *         "name": "Alice"
+                             *       }
+                             *       ]
+                             *     }
+                             *
+                             */
+                            data: {
+                                [key: string]: {
+                                    [key: string]: unknown;
+                                }[];
+                            };
+                        };
+                    };
+                };
+                /** @description Lix file not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Failed to open the Lix file. */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code?: string;
+                            message?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: never;
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;

package/node_modules/@lix-js/server-api-schema/package.json

@@ -0,0 +1,21 @@
+{
+	"private": true,
+	"name": "@lix-js/server-api-schema",
+	"type": "module",
+	"version": "0.1.0",
+	"license": "Apache-2.0",
+	"exports": {
+		".": "./dist/schema.d.ts"
+	},
+	"scripts": {
+		"build": "npx openapi-typescript ./src/schema.yaml -o ./dist/schema.d.ts",
+		"format": "prettier ./src --write"
+	},
+	"_comment": "Required for tree-shaking https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free",
+	"sideEffects": false,
+	"devDependencies": {
+		"openapi-typescript": "^7.4.3",
+		"prettier": "^3.3.3",
+		"typescript": "^5.5.4"
+	}
+}

package/node_modules/@lix-js/server-api-schema/src/schema.yaml

@@ -0,0 +1,290 @@
+openapi: 3.0.3
+info:
+  title: Lix Server Api
+  version: 1.0.0
+paths:
+  /lsa/new-v1:
+    post:
+      summary: Stores the lix on the server.
+      description: >
+        Use sync if you want to push or pull data from the server.
+      requestBody:
+        description: The lix binary.
+        required: true
+        content:
+          application/octet-stream:
+            schema:
+              format: binary
+
+      responses:
+        "201":
+          description: Lix file created successfully.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: string
+                    description: The ID of the created lix.
+                    example: "123e4567-e89b-12d3-a456-426614174000"
+
+        "400":
+          description: Invalid Lix file.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: Error message.
+                    example: "Invalid Lix file."
+
+        "409":
+          description: Lix file already exists.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: Error message.
+                    example: "Lix file already exists."
+
+  /lsa/get-v1:
+    post:
+      summary: Get the lix from the server.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - lix_id
+              properties:
+                lix_id:
+                  type: string
+                  description: The ID of the lix to get.
+                  example: "123e4567-e89b-12d3-a456-426614174000"
+      responses:
+        "200":
+          description: Lix file fetched successfully.
+          content:
+            application/octet-stream:
+              schema:
+                format: binary
+        "404":
+          description: Lix file not found.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: Error message.
+                    example: "Lix file not found."
+
+  /lsa/push-v1:
+    post:
+      summary: Push data to the server.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - lix_id
+                - vector_clock
+                - data
+              properties:
+                lix_id:
+                  type: string
+                  description: The ID of the lix to push to.
+                  example: "123e4567-e89b-12d3-a456-426614174000"
+                vector_clock:
+                  type: array
+                  items:
+                    type: object
+                    description: The vector clock of the client.
+                    required:
+                      - session
+                      - time
+                    properties:
+                      session:
+                        type: string
+                        description: The session ID of the client.
+                        example: "123e4567-e"
+                      time:
+                        type: integer
+                        description: The time of the client.
+                        example: 123456789
+                    example:
+                      123e4567-e89b-12d3-a456-426614174000: 1
+                data:
+                  type: object
+                  description: The data to push.
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: object
+                      additionalProperties: true
+                      example: >
+                        {
+                          "id": 1,
+                          "name": "Alice"
+                        }
+                  example: >
+                    {
+                      "table_name": [
+                      {
+                        "id": 1,
+                        "name": "Alice"
+                      }
+                      ]
+                    }
+
+      responses:
+        "201":
+          description: Rows pushed successfully.
+
+        "400":
+          description: Invalid row data.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: A machine-readable error code.
+                    example: "INVALID_ROW_DATA"
+                  message:
+                    type: string
+                    description: A human-readable error message.
+                    example: "The provided row data is invalid."
+
+        "404":
+          description: Lix not found.
+
+        "500":
+          description: Server error.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: Error message.
+                    example: "INTERNAL_SERVER_ERROR"
+                  message:
+                    type: string
+                    description: A human-readable error message.
+                    example: "An internal server error occurred."
+
+  /lsa/pull-v1:
+    post:
+      summary: Pull all data for all tables from the server.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - lix_id
+                - vector_clock
+              properties:
+                lix_id:
+                  type: string
+                  description: The ID of the lix to pull from.
+                  example: "123e4567-e89b-12d3-a456-426614174000"
+                vector_clock:
+                  type: array
+                  items:
+                    type: object
+                    description: The vector clock of the client.
+                    required:
+                      - session
+                      - time
+                    properties:
+                      session:
+                        type: string
+                        description: The session ID of the client.
+                        example: "123e4567-e"
+                      time:
+                        type: integer
+                        description: The time of the client.
+                        example: 123456789
+      responses:
+        "200":
+          description: Data fetched successfully.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - vector_clock
+                  - data
+                properties:
+                  vector_clock:
+                    type: array
+                    items:
+                      type: object
+                      description: The vector clock of the server.
+                      required:
+                        - session
+                        - time
+                      properties:
+                        session:
+                          type: string
+                          description: The session ID of the server.
+                          example: "123e4567-e"
+                        time:
+                          type: integer
+                          description: The time of the server.
+                      example:
+                        session: 123e4567-e89b-12d3-a456-426614174000
+                        time: 1
+                  data:
+                    type: object
+                    description: The data to push.
+                    additionalProperties:
+                      type: array
+                      items:
+                        type: object
+                        additionalProperties: true
+                        example: >
+                          {
+                            "id": 1,
+                            "name": "Alice"
+                          }
+                    required:
+                      - vector_clock
+                    example: >
+                      {
+                        "table_name": [
+                        {
+                          "id": 1,
+                          "name": "Alice"
+                        }
+                        ]
+                      }
+        "404":
+          description: Lix file not found.
+        "500":
+          description: Failed to open the Lix file.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                  message:
+                    type: string