@xata.io/client 0.2.2 → 0.3.0

package/dist/api/fetcher.d.ts

@@ -0,0 +1,25 @@
+export declare type FetchImpl = (url: string, init?: {
+    body?: string;
+    headers?: Record<string, string>;
+    method?: string;
+}) => Promise<{
+    ok: boolean;
+    status: number;
+    json(): Promise<any>;
+}>;
+export declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
+export declare type FetcherExtraProps = {
+    apiUrl: string;
+    workspacesApiUrl: string | WorkspaceApiUrlBuilder;
+    fetchImpl: FetchImpl;
+    apiKey: string;
+};
+export declare type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
+    url: string;
+    method: string;
+    body?: TBody;
+    headers?: THeaders;
+    queryParams?: TQueryParams;
+    pathParams?: TPathParams;
+};
+export declare function fetch<TData, TBody extends Record<string, unknown> | undefined, THeaders extends Record<string, unknown>, TQueryParams extends Record<string, unknown>, TPathParams extends Record<string, string>>({ url: path, method, body, headers, pathParams, queryParams, fetchImpl, apiKey, apiUrl, workspacesApiUrl }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> & FetcherExtraProps): Promise<TData>;

package/dist/api/fetcher.js

@@ -0,0 +1,78 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetch = void 0;
+const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
+    const query = new URLSearchParams(queryParams).toString();
+    const queryString = query.length > 0 ? `?${query}` : '';
+    return url.replace(/\{\w*\}/g, (key) => pathParams[key.slice(1, -1)]) + queryString;
+};
+const fallbackError = { message: 'Network response was not ok' };
+function buildBaseUrl({ path, workspacesApiUrl, apiUrl, pathParams }) {
+    if (!(pathParams === null || pathParams === void 0 ? void 0 : pathParams.workspace))
+        return `${apiUrl}${path}`;
+    const url = typeof workspacesApiUrl === 'string' ? `${workspacesApiUrl}${path}` : workspacesApiUrl(path, pathParams);
+    return url.replace('{workspaceId}', pathParams.workspace);
+}
+// The host header is needed by Node.js on localhost.
+// It is ignored by fetch() in the frontend
+function hostHeader(url) {
+    var _a;
+    const pattern = /.*:\/\/(?<host>[^/]+).*/;
+    const { groups } = (_a = pattern.exec(url)) !== null && _a !== void 0 ? _a : {};
+    return (groups === null || groups === void 0 ? void 0 : groups.host) ? { Host: groups.host } : {};
+}
+function fetch({ url: path, method, body, headers, pathParams, queryParams, fetchImpl, apiKey, apiUrl, workspacesApiUrl }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const baseUrl = buildBaseUrl({ path, workspacesApiUrl, pathParams, apiUrl });
+        const fullUrl = resolveUrl(baseUrl, queryParams, pathParams);
+        // Node.js on localhost won't resolve localhost subdomains unless mapped in /etc/hosts
+        // So, instead, we use localhost without subdomains, but will add a Host header
+        const url = fullUrl.includes('localhost') ? fullUrl.replace(/^[^.]+\./, 'http://') : fullUrl;
+        const response = yield fetchImpl(url, {
+            method: method.toUpperCase(),
+            body: body ? JSON.stringify(body) : undefined,
+            headers: Object.assign(Object.assign(Object.assign({ 'Content-Type': 'application/json' }, headers), hostHeader(fullUrl)), { Authorization: `Bearer ${apiKey}` })
+        });
+        // No content
+        if (response.status === 204) {
+            return {};
+        }
+        try {
+            const jsonResponse = yield response.json();
+            if (response.ok) {
+                return jsonResponse;
+            }
+            if (jsonResponse.message) {
+                throw withStatus({ message: jsonResponse.message }, response.status);
+            }
+            else {
+                throw withStatus(fallbackError, response.status);
+            }
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                const error = {
+                    message: e.message
+                };
+                throw withStatus(error, response.status);
+            }
+            else if (typeof e === 'object' && typeof e.message === 'string') {
+                throw withStatus(e, response.status);
+            }
+            else {
+                throw withStatus(fallbackError, response.status);
+            }
+        }
+    });
+}
+exports.fetch = fetch;
+const withStatus = (error, status) => (Object.assign(Object.assign({}, error), { status }));

package/dist/api/index.d.ts

@@ -0,0 +1,7 @@
+import { operationsByTag } from './components';
+import type * as Responses from './responses';
+import type * as Schemas from './schemas';
+export * from './client';
+export * from './components';
+export { operationsByTag as Operations };
+export type { Responses, Schemas };

package/dist/api/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operations = void 0;
+const components_1 = require("./components");
+Object.defineProperty(exports, "Operations", { enumerable: true, get: function () { return components_1.operationsByTag; } });
+__exportStar(require("./client"), exports);
+__exportStar(require("./components"), exports);

package/dist/api/parameters.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by @openapi-codegen
+ *
+ * @version 1.0
+ */
+import type * as Schemas from './schemas';
+export declare type APIKeyNameParam = Schemas.APIKeyName;
+export declare type InviteIDParam = Schemas.InviteID;
+export declare type InviteKeyParam = Schemas.InviteKey;
+export declare type UserIDParam = Schemas.UserID;
+export declare type WorkspaceIDParam = Schemas.WorkspaceID;
+export declare type ColumnNameParam = Schemas.ColumnName;
+export declare type DBBranchNameParam = Schemas.DBBranchName;
+export declare type DBNameParam = Schemas.DBName;
+export declare type RecordIDParam = Schemas.RecordID;
+export declare type TableNameParam = Schemas.TableName;

package/dist/api/parameters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/providers.d.ts

@@ -0,0 +1,8 @@
+declare type HostAliases = 'production' | 'staging';
+declare type ProviderBuilder = {
+    main: string;
+    workspaces: string;
+};
+export declare type HostProvider = HostAliases | ProviderBuilder;
+export declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder): string;
+export {};

package/dist/api/providers.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHostUrl = void 0;
+function getHostUrl(provider, type) {
+    if (isValidAlias(provider)) {
+        return providers[provider][type];
+    }
+    else if (isValidBuilder(provider)) {
+        return provider[type];
+    }
+    throw new Error('Invalid API provider');
+}
+exports.getHostUrl = getHostUrl;
+const providers = {
+    production: {
+        main: 'https://api.xata.io',
+        workspaces: 'https://{workspaceId}.xata.sh'
+    },
+    staging: {
+        main: 'https://staging.xatabase.co',
+        workspaces: 'https://{workspaceId}.staging.xatabase.co'
+    }
+};
+function isValidAlias(alias) {
+    return typeof alias === 'string' && Object.keys(providers).includes(alias);
+}
+function isValidBuilder(builder) {
+    return typeof builder === 'object' && typeof builder.main === 'string' && typeof builder.workspaces === 'string';
+}

package/dist/api/responses.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Generated by @openapi-codegen
+ *
+ * @version 1.0
+ */
+import type * as Schemas from './schemas';
+export declare type SimpleError = {
+    id?: string;
+    message: string;
+};
+export declare type BadRequestError = {
+    id?: string;
+    message: string;
+};
+/**
+ * @example {"message":"invalid API key"}
+ */
+export declare type AuthError = {
+    id?: string;
+    message: string;
+};
+export declare type BranchMigrationPlan = {
+    version: number;
+    migration: Schemas.BranchMigration;
+};
+export declare type RecordUpdateResponse = {
+    id: string;
+    xata: {
+        version: number;
+    };
+};
+export declare type QueryResponse = {
+    records: Schemas.XataRecord[];
+    meta: Schemas.RecordsMetadata;
+};
+export declare type SearchResponse = {
+    records: Schemas.XataRecord[];
+};
+/**
+ * @example {"migrationID":"mig_c7m19ilcefoebpqj12p0"}
+ */
+export declare type MigrationIdResponse = {
+    migrationID: string;
+};

package/dist/api/responses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/schemas.d.ts

@@ -0,0 +1,311 @@
+/**
+ * Generated by @openapi-codegen
+ *
+ * @version 1.0
+ */
+export declare type User = {
+    email: string;
+    fullname: string;
+    image: string;
+};
+/**
+ * @pattern [a-zA-Z0-9_-~:]+
+ */
+export declare type UserID = string;
+export declare type UserWithID = User & {
+    id: UserID;
+};
+/**
+ * @format date-time
+ * @x-go-type string
+ */
+export declare type DateTime = string;
+/**
+ * @pattern [a-zA-Z0-9_\-~]*
+ */
+export declare type APIKeyName = string;
+/**
+ * @pattern ^([a-zA-Z0-9][a-zA-Z0-9_\-~]+-)?[a-zA-Z0-9]{6}
+ * @x-go-type auth.WorkspaceID
+ */
+export declare type WorkspaceID = string;
+/**
+ * @x-go-type auth.Role
+ */
+export declare type Role = 'owner' | 'maintainer';
+export declare type WorkspaceMeta = {
+    name: string;
+    slug: string;
+};
+export declare type Workspace = WorkspaceMeta & {
+    id: WorkspaceID;
+    memberCount: number;
+    plan: 'free';
+};
+export declare type WorkspaceMember = {
+    userId: UserID;
+    fullname: string;
+    email: string;
+    role: Role;
+};
+/**
+ * @pattern [a-zA-Z0-9]+
+ */
+export declare type InviteID = string;
+export declare type WorkspaceInvite = {
+    inviteId: InviteID;
+    email: string;
+    expires: string;
+    role: Role;
+};
+export declare type WorkspaceMembers = {
+    members: WorkspaceMember[];
+    invites: WorkspaceInvite[];
+};
+/**
+ * @pattern ^ik_[a-zA-Z0-9]+
+ */
+export declare type InviteKey = string;
+export declare type ListDatabasesResponse = {
+    databases?: {
+        name: string;
+        displayName: string;
+        createdAt: DateTime;
+        numberOfBranches: number;
+        ui?: {
+            color?: string;
+        };
+    }[];
+};
+export declare type ListBranchesResponse = {
+    databaseName: string;
+    displayName: string;
+    branches: Branch[];
+};
+export declare type Branch = {
+    name: string;
+    createdAt: DateTime;
+};
+/**
+ * @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
+ * @x-go-type xata.BranchMetadata
+ */
+export declare type BranchMetadata = {
+    repository?: string;
+    branch?: BranchName;
+    stage?: string;
+    labels?: string[];
+};
+export declare type DBBranch = {
+    databaseName: DBName;
+    branchName: BranchName;
+    createdAt: DateTime;
+    id: string;
+    version: number;
+    lastMigrationID: string;
+    metadata?: BranchMetadata;
+    startedFrom?: StartedFromMetadata;
+    schema: Schema;
+};
+export declare type StartedFromMetadata = {
+    branchName: BranchName;
+    dbBranchID: string;
+    migrationID: string;
+};
+/**
+ * @x-go-type xata.Schema
+ */
+export declare type Schema = {
+    tables: Table[];
+    tablesOrder?: string[];
+};
+export declare type Table = {
+    id?: string;
+    name: TableName;
+    columns: Column[];
+    revLinks?: RevLink[];
+};
+/**
+ * @x-go-type xata.Column
+ */
+export declare type Column = {
+    name: string;
+    type: 'bool' | 'int' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object';
+    link?: {
+        table: string;
+    };
+    columns?: Column[];
+};
+export declare type RevLink = {
+    linkID: string;
+    table: string;
+};
+/**
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+export declare type BranchName = string;
+/**
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+export declare type DBName = string;
+/**
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+ *
+ * @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
+ */
+export declare type DBBranchName = string;
+/**
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+export declare type TableName = string;
+/**
+ * @pattern [a-zA-Z0-9_\-~\.]+
+ */
+export declare type ColumnName = string;
+export declare type MetricsDatapoint = {
+    timestamp: string;
+    value: number;
+};
+export declare type MetricsLatency = {
+    p50?: MetricsDatapoint[];
+    p90?: MetricsDatapoint[];
+};
+export declare type BranchMigration = {
+    id?: string;
+    parentID?: string;
+    status: string;
+    title?: string;
+    lastGitRevision?: string;
+    localChanges: boolean;
+    createdAt?: DateTime;
+    newTables?: {
+        [key: string]: Table;
+    };
+    removedTables?: string[];
+    tableMigrations?: {
+        [key: string]: TableMigration;
+    };
+    newTableOrder: string[];
+    renamedTables?: TableRename[];
+};
+export declare type TableMigration = {
+    newColumns?: {
+        [key: string]: Column;
+    };
+    removedColumns?: string[];
+    modifiedColumns?: ColumnMigration[];
+    newColumnOrder: string[];
+};
+export declare type ColumnMigration = {
+    old: Column;
+    ['new']: Column;
+};
+export declare type SortExpression = string[] | {
+    [key: string]: SortOrder;
+} | {
+    [key: string]: SortOrder;
+}[];
+export declare type SortOrder = 'asc' | 'desc';
+/**
+ * @minProperties 1
+ */
+export declare type FilterExpression = {
+    $exists?: string;
+    $existsNot?: string;
+    $any?: FilterList;
+    $all?: FilterList;
+    $none?: FilterList;
+    $not?: FilterList;
+} & {
+    [key: string]: FilterColumn;
+};
+export declare type FilterList = FilterExpression | FilterExpression[];
+export declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
+/**
+ * @maxProperties 1
+ * @minProperties 1
+ */
+export declare type FilterColumnIncludes = {
+    $includes?: FilterPredicate;
+    $includesAny?: FilterPredicate;
+    $includesAll?: FilterPredicate;
+    $includesNone?: FilterPredicate;
+};
+export declare type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
+/**
+ * @maxProperties 1
+ * @minProperties 1
+ */
+export declare type FilterPredicateOp = {
+    $any?: FilterPredicate[];
+    $all?: FilterPredicate[];
+    $none?: FilterPredicate | FilterPredicate[];
+    $not?: FilterPredicate | FilterPredicate[];
+    $is?: FilterValue | FilterValue[];
+    $isNot?: FilterValue | FilterValue[];
+    $lt?: FilterRangeValue;
+    $le?: FilterRangeValue;
+    $gt?: FilterRangeValue;
+    $ge?: FilterRangeValue;
+    $contains?: string;
+    $startsWith?: string;
+    $endsWith?: string;
+    $pattern?: string;
+};
+/**
+ * @maxProperties 2
+ * @minProperties 2
+ */
+export declare type FilterPredicateRangeOp = {
+    $lt?: FilterRangeValue;
+    $le?: FilterRangeValue;
+    $gt?: FilterRangeValue;
+    $ge?: FilterRangeValue;
+};
+export declare type FilterRangeValue = number | string;
+export declare type FilterValue = number | string | boolean;
+/**
+ * Pagination settings.
+ */
+export declare type PageConfig = {
+    after?: string;
+    before?: string;
+    first?: string;
+    last?: string;
+    size?: number;
+    offset?: number;
+};
+export declare type ColumnsFilter = string[];
+/**
+ * @pattern [a-zA-Z0-9_-~:]+
+ */
+export declare type RecordID = string;
+/**
+ * @example {"newName":"newName","oldName":"oldName"}
+ */
+export declare type TableRename = {
+    newName: string;
+    oldName: string;
+};
+/**
+ * Records metadata
+ */
+export declare type RecordsMetadata = {
+    page: {
+        cursor: string;
+        more: boolean;
+    };
+};
+/**
+ * Xata Table Record
+ */
+export declare type XataRecord = {
+    id: RecordID;
+    xata: {
+        version: number;
+        table?: string;
+        warnings?: string[];
+    };
+} & {
+    [key: string]: any;
+};

package/dist/api/schemas.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });