@xata.io/client 0.8.1 → 0.8.4

package/dist/api/fetcher.d.ts

@@ -1,40 +0,0 @@
-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>;
-export declare class FetcherError extends Error {
-    status: number;
-    errors: Array<{
-        status: number;
-        message?: string;
-    }> | undefined;
-    constructor(data: {
-        message: string;
-        status: number;
-        errors?: Array<{
-            status: number;
-            message?: string;
-        }>;
-    }, parent?: Error);
-}

package/dist/api/fetcher.js

@@ -1,79 +0,0 @@
-"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.FetcherError = exports.fetch = void 0;
-const lang_1 = require("../util/lang");
-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;
-};
-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;
-            }
-            const { message = 'Unknown error', errors } = jsonResponse;
-            throw new FetcherError({ message, status: response.status, errors });
-        }
-        catch (error) {
-            const message = hasMessage(error) ? error.message : 'Unknown network error';
-            const parent = error instanceof Error ? error : undefined;
-            throw new FetcherError({ message, status: response.status }, parent);
-        }
-    });
-}
-exports.fetch = fetch;
-const hasMessage = (error) => {
-    return (0, lang_1.isObject)(error) && (0, lang_1.isString)(error.message);
-};
-class FetcherError extends Error {
-    constructor(data, parent) {
-        super(data.message);
-        this.status = data.status;
-        this.errors = data.errors;
-        if (parent) {
-            this.stack = parent.stack;
-            this.cause = parent.cause;
-        }
-    }
-}
-exports.FetcherError = FetcherError;

package/dist/api/index.d.ts

@@ -1,13 +0,0 @@
-import { XataPlugin, XataPluginOptions } from '../plugins';
-import { XataApiClient } from './client';
-import { operationsByTag } from './components';
-import type * as Responses from './responses';
-import type * as Schemas from './schemas';
-export * from './client';
-export * from './components';
-export type { FetcherExtraProps, FetchImpl } from './fetcher';
-export { operationsByTag as Operations };
-export type { Responses, Schemas };
-export declare class XataApiPlugin implements XataPlugin {
-    build(options: XataPluginOptions): Promise<XataApiClient>;
-}

package/dist/api/index.js

@@ -1,40 +0,0 @@
-"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);
-};
-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.XataApiPlugin = exports.Operations = void 0;
-const client_1 = require("./client");
-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);
-class XataApiPlugin {
-    build(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { fetchImpl, apiKey } = yield options.getFetchProps();
-            return new client_1.XataApiClient({ fetch: fetchImpl, apiKey });
-        });
-    }
-}
-exports.XataApiPlugin = XataApiPlugin;

package/dist/api/parameters.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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

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

package/dist/api/providers.d.ts

@@ -1,8 +0,0 @@
-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

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostUrl = void 0;
-const lang_1 = require("../util/lang");
-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 (0, lang_1.isString)(alias) && Object.keys(providers).includes(alias);
-}
-function isValidBuilder(builder) {
-    return (0, lang_1.isObject)(builder) && (0, lang_1.isString)(builder.main) && (0, lang_1.isString)(builder.workspaces);
-}

package/dist/api/responses.d.ts

@@ -1,50 +0,0 @@
-/**
- * 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 BulkError = {
-    errors: {
-        message?: string;
-        status?: number;
-    }[];
-};
-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

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

package/dist/api/schemas.d.ts

@@ -1,311 +0,0 @@
-/**
- * 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' | 'float' | '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

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

package/dist/client.d.ts

@@ -1,27 +0,0 @@
-import { FetchImpl } from './api/fetcher';
-import { XataPlugin } from './plugins';
-import { SchemaPlugin } from './schema';
-import { BaseData } from './schema/record';
-import { LinkDictionary } from './schema/repository';
-import { SearchPlugin } from './search';
-import { BranchStrategyOption } from './util/branches';
-import { StringKeys } from './util/types';
-export declare type BaseClientOptions = {
-    fetch?: FetchImpl;
-    apiKey?: string;
-    databaseURL?: string;
-    branch?: BranchStrategyOption;
-};
-export declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
-export interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
-    new <Schemas extends Record<string, BaseData>>(options?: Partial<BaseClientOptions>, links?: LinkDictionary): Omit<{
-        db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
-        search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
-    }, keyof Plugins> & {
-        [Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
-    };
-}
-declare const BaseClient_base: ClientConstructor<{}>;
-export declare class BaseClient extends BaseClient_base<Record<string, any>> {
-}
-export {};