@apito-io/js-admin-sdk 2.0.0

package/src/types.ts

@@ -0,0 +1,170 @@
+/**
+ * Type definitions for the Apito JavaScript SDK
+ */
+
+export interface MetaField {
+  created_at: string;
+  updated_at: string;
+  status: string;
+  revision?: string;
+  revision_at?: string;
+  root_revision_id?: string;
+}
+
+export interface DefaultDocumentStructure {
+  _key?: string;
+  _id?: string;
+  data: any;
+  meta?: MetaField;
+  id: string;
+  expire_at?: string | number;
+  relation_doc_id?: string;
+  last_revision_doc_id?: string;
+  type?: string;
+  tenant_id?: string;
+  tenant_model?: string;
+}
+
+export interface SearchResult {
+  results: DefaultDocumentStructure[];
+  count: number;
+}
+
+export interface TypedDocumentStructure<T> {
+  _key?: string;
+  _id?: string;
+  data: T;
+  meta?: MetaField;
+  id: string;
+  expire_at?: string | number;
+  relation_doc_id?: string;
+  last_revision_doc_id?: string;
+  type?: string;
+  tenant_id?: string;
+  tenant_model?: string;
+}
+
+export interface TypedSearchResult<T> {
+  results: TypedDocumentStructure<T>[];
+  count: number;
+}
+
+export interface Filter {
+  page?: number;
+  offset?: number;
+  limit?: number;
+  order?: string;
+  min?: number;
+  max?: number;
+  category?: string;
+}
+
+export interface GraphQLErrorLocation {
+  line: number;
+  column: number;
+}
+
+export interface GraphQLError {
+  message: string;
+  locations?: GraphQLErrorLocation[];
+  path?: (string | number)[];
+  extensions?: Record<string, any>;
+}
+
+export interface GraphQLResponse {
+  data?: any;
+  errors?: GraphQLError[];
+}
+
+export interface CreateAndUpdateRequest {
+  id?: string;
+  model: string;
+  payload: any;
+  connect?: Record<string, any>;
+  disconnect?: Record<string, any>;
+  singlePageData?: boolean;
+  forceUpdate?: boolean;
+}
+
+export interface ClientConfig {
+  baseURL: string;
+  apiKey: string;
+  timeout?: number;
+  httpClient?: any;
+  tenantId?: string;
+}
+
+export interface RequestOptions {
+  headers?: Record<string, string>;
+  timeout?: number;
+}
+
+export interface SearchOptions {
+  limit?: number;
+  page?: number;
+  offset?: number;
+  where?: Record<string, any>;
+  search?: string;
+  sort?: Record<string, 1 | -1>;
+}
+
+export interface ConnectionOptions {
+  model: string;
+  filter?: SearchOptions;
+}
+
+// Plugin interface matching the Go SDK
+export interface InjectedDBOperationInterface {
+  generateTenantToken(token: string, tenantId: string): Promise<string>;
+  getSingleResource(model: string, id: string, singlePageData?: boolean): Promise<DefaultDocumentStructure>;
+  searchResources(model: string, filter?: Record<string, any>, aggregate?: boolean): Promise<SearchResult>;
+  getRelationDocuments(id: string, connection: Record<string, any>): Promise<SearchResult>;
+  createNewResource(request: CreateAndUpdateRequest): Promise<DefaultDocumentStructure>;
+  updateResource(request: CreateAndUpdateRequest): Promise<DefaultDocumentStructure>;
+  deleteResource(model: string, id: string): Promise<void>;
+  debug(stage: string, ...data: any[]): Promise<any>;
+}
+
+// Typed operations interface
+export interface TypedOperations {
+  getSingleResourceTyped<T>(model: string, id: string, singlePageData?: boolean): Promise<TypedDocumentStructure<T>>;
+  searchResourcesTyped<T>(model: string, filter?: Record<string, any>, aggregate?: boolean): Promise<TypedSearchResult<T>>;
+  getRelationDocumentsTyped<T>(id: string, connection: Record<string, any>): Promise<TypedSearchResult<T>>;
+  createNewResourceTyped<T>(request: CreateAndUpdateRequest): Promise<TypedDocumentStructure<T>>;
+  updateResourceTyped<T>(request: CreateAndUpdateRequest): Promise<TypedDocumentStructure<T>>;
+}
+
+// Error classes
+export class ApitoError extends Error {
+  constructor(
+    message: string,
+    public code?: string,
+    public statusCode?: number,
+    public details?: any
+  ) {
+    super(message);
+    this.name = 'ApitoError';
+  }
+}
+
+export class GraphQLError extends ApitoError {
+  constructor(
+    message: string,
+    public graphQLErrors: GraphQLError[],
+    public response?: any
+  ) {
+    super(message, 'GRAPHQL_ERROR');
+    this.name = 'GraphQLError';
+  }
+
+  get partialData(): any {
+    return this.response?.data;
+  }
+}
+
+export class ValidationError extends ApitoError {
+  constructor(message: string, public field?: string) {
+    super(message, 'VALIDATION_ERROR');
+    this.name = 'ValidationError';
+  }
+}

package/src/version.ts

@@ -0,0 +1,11 @@
+/**
+ * Apito JavaScript internal SDK version (kept in sync with package.json for releases)
+ */
+export const Version = '2.0.0';
+
+/**
+ * GetVersion returns the current version of the SDK
+ */
+export function getVersion(): string {
+    return Version;
+}