@igorchugurov/public-api-sdk 1.1.0 → 1.2.0

package/README.md

@@ -152,7 +152,7 @@ const { data, pagination } = await sdk.getInstances(entityDefinitionId, {
 
 #### `getInstance(entityDefinitionId, id, params?)`
 
-Получить один экземпляр.
+Получить один экземпляр по ID.
 
 ```typescript
 const instance = await sdk.getInstance(entityDefinitionId, id, {
@@ -160,6 +160,40 @@ const instance = await sdk.getInstance(entityDefinitionId, id, {
 });
 ```
 
+**Пример:**
+
+```typescript
+const instance = await sdk.getInstance("entity-def-id", "instance-id", {
+  relationsAsIds: true, // для редактирования - нужны только ID
+});
+```
+
+#### `getInstanceBySlug(entityDefinitionId, slug, params?)`
+
+Получить один экземпляр по slug.
+
+```typescript
+const instance = await sdk.getInstanceBySlug(entityDefinitionId, slug, {
+  relationsAsIds?: boolean; // default: false
+});
+```
+
+**Пример:**
+
+```typescript
+const instance = await sdk.getInstanceBySlug("entity-def-id", "my-article-slug", {
+  relationsAsIds: false, // для отображения - нужны полные объекты
+});
+```
+
+**Особенности:**
+- Валидирует формат slug перед запросом (только строчные латинские буквы, цифры и дефисы)
+- Работает аналогично `getInstance`, но ищет по slug вместо id
+- Поддерживает те же параметры, что и `getInstance` (relationsAsIds)
+- Параметр `relationsAsIds`:
+  - `false` (по умолчанию) - возвращает полные объекты связанных сущностей
+  - `true` - возвращает только массивы ID связанных сущностей
+
 #### `createInstance(entityDefinitionId, data)`
 
 Создать новый экземпляр. Автоматически генерирует уникальный `slug` из поля `name`.

package/dist/{client-BV5AAKYo.d.mts → client-DS5xnLAo.d.mts}

@@ -1109,6 +1109,9 @@ declare abstract class BasePublicAPIClient {
     abstract getInstance(entityDefinitionId: string, id: string, params?: {
         relationsAsIds?: boolean;
     }): Promise<EntityInstanceWithFields>;
+    abstract getInstanceBySlug(entityDefinitionId: string, slug: string, params?: {
+        relationsAsIds?: boolean;
+    }): Promise<EntityInstanceWithFields>;
     abstract createInstance(entityDefinitionId: string, data: CreateInstanceData): Promise<EntityInstanceWithFields>;
     abstract updateInstance(entityDefinitionId: string, id: string, data: UpdateInstanceData): Promise<EntityInstanceWithFields>;
     abstract deleteInstance(entityDefinitionId: string, id: string): Promise<void>;
@@ -1152,6 +1155,12 @@ declare class PublicAPIClient extends BasePublicAPIClient {
     getInstance(entityDefinitionId: string, id: string, params?: {
         relationsAsIds?: boolean;
     }): Promise<EntityInstanceWithFields>;
+    /**
+     * Получить один экземпляр по slug
+     */
+    getInstanceBySlug(entityDefinitionId: string, slug: string, params?: {
+        relationsAsIds?: boolean;
+    }): Promise<EntityInstanceWithFields>;
     /**
      * Получить список экземпляров
      * Поддерживает поиск, фильтры (JSONB и relation), пагинацию

package/dist/{client-BV5AAKYo.d.ts → client-DS5xnLAo.d.ts}

@@ -1109,6 +1109,9 @@ declare abstract class BasePublicAPIClient {
     abstract getInstance(entityDefinitionId: string, id: string, params?: {
         relationsAsIds?: boolean;
     }): Promise<EntityInstanceWithFields>;
+    abstract getInstanceBySlug(entityDefinitionId: string, slug: string, params?: {
+        relationsAsIds?: boolean;
+    }): Promise<EntityInstanceWithFields>;
     abstract createInstance(entityDefinitionId: string, data: CreateInstanceData): Promise<EntityInstanceWithFields>;
     abstract updateInstance(entityDefinitionId: string, id: string, data: UpdateInstanceData): Promise<EntityInstanceWithFields>;
     abstract deleteInstance(entityDefinitionId: string, id: string): Promise<void>;
@@ -1152,6 +1155,12 @@ declare class PublicAPIClient extends BasePublicAPIClient {
     getInstance(entityDefinitionId: string, id: string, params?: {
         relationsAsIds?: boolean;
     }): Promise<EntityInstanceWithFields>;
+    /**
+     * Получить один экземпляр по slug
+     */
+    getInstanceBySlug(entityDefinitionId: string, slug: string, params?: {
+        relationsAsIds?: boolean;
+    }): Promise<EntityInstanceWithFields>;
     /**
      * Получить список экземпляров
      * Поддерживает поиск, фильтры (JSONB и relation), пагинацию

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { F as FieldConfig, a as FieldValue, E as EntityDefinition, b as Field, c as EntityUIConfig, C as ColumnConfig, S as SDKOptions, P as PublicAPIClient } from './client-BV5AAKYo.mjs';
-export { y as ActionConfig, A as AuthResult, g as CreateInstanceData, D as DbType, l as DbTypeToTSType, m as EntityData, e as EntityDefinitionConfig, x as EntityFile, n as EntityInstance, q as EntityInstanceWithFields, p as EntityRelation, k as FieldOption, j as FieldType, r as FilterValue, z as FormPageConfig, G as GetInstancesOptions, I as InstanceData, L as ListPageConfig, M as MessagesConfig, h as PaginationResult, w as PartialInstanceData, B as PartialUIConfig, d as ProjectConfig, Q as QueryParams, R as RelationFilterInfo, f as RelationFilterMode, o as RelationType, s as RelationsData, i as SignUpData, U as UpdateInstanceData, v as getFieldValue, u as isEntityData, t as isFieldValue } from './client-BV5AAKYo.mjs';
+import { F as FieldConfig, a as FieldValue, E as EntityDefinition, b as Field, c as EntityUIConfig, C as ColumnConfig, S as SDKOptions, P as PublicAPIClient } from './client-DS5xnLAo.mjs';
+export { y as ActionConfig, A as AuthResult, g as CreateInstanceData, D as DbType, l as DbTypeToTSType, m as EntityData, e as EntityDefinitionConfig, x as EntityFile, n as EntityInstance, q as EntityInstanceWithFields, p as EntityRelation, k as FieldOption, j as FieldType, r as FilterValue, z as FormPageConfig, G as GetInstancesOptions, I as InstanceData, L as ListPageConfig, M as MessagesConfig, h as PaginationResult, w as PartialInstanceData, B as PartialUIConfig, d as ProjectConfig, Q as QueryParams, R as RelationFilterInfo, f as RelationFilterMode, o as RelationType, s as RelationsData, i as SignUpData, U as UpdateInstanceData, v as getFieldValue, u as isEntityData, t as isFieldValue } from './client-DS5xnLAo.mjs';
 import '@supabase/supabase-js';
 
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { F as FieldConfig, a as FieldValue, E as EntityDefinition, b as Field, c as EntityUIConfig, C as ColumnConfig, S as SDKOptions, P as PublicAPIClient } from './client-BV5AAKYo.js';
-export { y as ActionConfig, A as AuthResult, g as CreateInstanceData, D as DbType, l as DbTypeToTSType, m as EntityData, e as EntityDefinitionConfig, x as EntityFile, n as EntityInstance, q as EntityInstanceWithFields, p as EntityRelation, k as FieldOption, j as FieldType, r as FilterValue, z as FormPageConfig, G as GetInstancesOptions, I as InstanceData, L as ListPageConfig, M as MessagesConfig, h as PaginationResult, w as PartialInstanceData, B as PartialUIConfig, d as ProjectConfig, Q as QueryParams, R as RelationFilterInfo, f as RelationFilterMode, o as RelationType, s as RelationsData, i as SignUpData, U as UpdateInstanceData, v as getFieldValue, u as isEntityData, t as isFieldValue } from './client-BV5AAKYo.js';
+import { F as FieldConfig, a as FieldValue, E as EntityDefinition, b as Field, c as EntityUIConfig, C as ColumnConfig, S as SDKOptions, P as PublicAPIClient } from './client-DS5xnLAo.js';
+export { y as ActionConfig, A as AuthResult, g as CreateInstanceData, D as DbType, l as DbTypeToTSType, m as EntityData, e as EntityDefinitionConfig, x as EntityFile, n as EntityInstance, q as EntityInstanceWithFields, p as EntityRelation, k as FieldOption, j as FieldType, r as FilterValue, z as FormPageConfig, G as GetInstancesOptions, I as InstanceData, L as ListPageConfig, M as MessagesConfig, h as PaginationResult, w as PartialInstanceData, B as PartialUIConfig, d as ProjectConfig, Q as QueryParams, R as RelationFilterInfo, f as RelationFilterMode, o as RelationType, s as RelationsData, i as SignUpData, U as UpdateInstanceData, v as getFieldValue, u as isEntityData, t as isFieldValue } from './client-DS5xnLAo.js';
 import '@supabase/supabase-js';
 
 /**

package/dist/index.js

@@ -34,7 +34,8 @@ var __export = (target, all) => {
 var slug_exports = {};
 __export(slug_exports, {
   generateSlug: () => generateSlug,
-  generateUniqueSlugForInstance: () => generateUniqueSlugForInstance
+  generateUniqueSlugForInstance: () => generateUniqueSlugForInstance,
+  validateSlug: () => validateSlug
 });
 function generateSlug(name) {
   if (!name || typeof name !== "string") {
@@ -42,6 +43,16 @@ function generateSlug(name) {
   }
   return name.toLowerCase().trim().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "").substring(0, 100);
 }
+function validateSlug(slug) {
+  if (!slug || typeof slug !== "string") {
+    return false;
+  }
+  if (slug.length === 0 || slug.length > 100) {
+    return false;
+  }
+  const slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+  return slugRegex.test(slug);
+}
 function generateRandomSuffix() {
   return Math.random().toString(36).substring(2, 6);
 }
@@ -756,6 +767,7 @@ function flattenInstance(instance, fields, relationsAsIds = false) {
 }
 
 // src/client.ts
+init_slug();
 var _PublicAPIClient = class _PublicAPIClient extends BasePublicAPIClient {
   constructor(supabase, projectId, mode, options = {}) {
     super(supabase, projectId, options);
@@ -907,6 +919,134 @@ var _PublicAPIClient = class _PublicAPIClient extends BasePublicAPIClient {
       handleSupabaseError(error);
     }
   }
+  /**
+   * Получить один экземпляр по slug
+   */
+  async getInstanceBySlug(entityDefinitionId, slug, params) {
+    var _a;
+    try {
+      if (!validateSlug(slug)) {
+        throw new ValidationError(
+          "slug",
+          "Slug must contain only lowercase letters, numbers, and hyphens, and cannot start or end with a hyphen"
+        );
+      }
+      const fields = await this.getFields(entityDefinitionId);
+      const { data: instance, error: instanceError } = await this.supabase.from("entity_instance").select("*").eq("slug", slug).eq("entity_definition_id", entityDefinitionId).eq("project_id", this.projectId).single();
+      if (instanceError || !instance) {
+        handleInstanceError(
+          instanceError || new Error("Instance not found"),
+          slug
+        );
+      }
+      const transformedInstance = transformEntityInstance(instance);
+      if (transformedInstance.entityDefinitionId !== entityDefinitionId) {
+        throw new NotFoundError("Entity instance", slug);
+      }
+      const relationFields = fields.filter(
+        (f) => f.dbType === "manyToMany" || f.dbType === "manyToOne" || f.dbType === "oneToMany" || f.dbType === "oneToOne"
+      );
+      const relations = {};
+      if (relationFields.length > 0) {
+        const relationFieldIds = relationFields.map((f) => f.id).filter((id) => Boolean(id));
+        if (relationFieldIds.length > 0) {
+          const { data: allRelations, error: relationsError } = await this.supabase.from("entity_relation").select("target_instance_id, relation_field_id").eq("source_instance_id", transformedInstance.id).in("relation_field_id", relationFieldIds);
+          if (relationsError) {
+            throw new SDKError(
+              "RELATIONS_LOAD_ERROR",
+              `Failed to load relations for instance with slug ${slug}: ${relationsError.message}`,
+              500,
+              relationsError
+            );
+          }
+          if (allRelations && allRelations.length > 0) {
+            const targetInstanceIds = [
+              ...new Set(allRelations.map((r) => r.target_instance_id))
+            ];
+            const { data: relatedInstances, error: instancesError } = await this.supabase.from("entity_instance").select("*").in("id", targetInstanceIds);
+            if (instancesError) {
+              throw new SDKError(
+                "RELATED_INSTANCES_LOAD_ERROR",
+                `Failed to load related instances for instance with slug ${slug}: ${instancesError.message}`,
+                500,
+                instancesError
+              );
+            }
+            if (relatedInstances) {
+              const relatedInstancesMap = new Map(
+                relatedInstances.map((inst) => [
+                  inst.id,
+                  transformEntityInstance(inst)
+                ])
+              );
+              for (const relation of allRelations) {
+                const relationField = relationFields.find(
+                  (f) => f.id === relation.relation_field_id
+                );
+                if (relationField) {
+                  const relatedInstance = relatedInstancesMap.get(
+                    relation.target_instance_id
+                  );
+                  if (relatedInstance) {
+                    if (!relations[relationField.name]) {
+                      relations[relationField.name] = [];
+                    }
+                    relations[relationField.name].push(
+                      relatedInstance
+                    );
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+      const fileFields = fields.filter(
+        (f) => f.type === "files" || f.type === "images"
+      );
+      if (fileFields.length > 0) {
+        const { data: allFiles, error: filesError } = await this.supabase.from("entity_file").select("id, field_id").eq("entity_instance_id", transformedInstance.id);
+        if (filesError) {
+          throw new SDKError(
+            "FILES_LOAD_ERROR",
+            `Failed to load files for instance with slug ${slug}: ${filesError.message}`,
+            500,
+            filesError
+          );
+        }
+        if (allFiles) {
+          const filesByFieldId = /* @__PURE__ */ new Map();
+          allFiles.forEach((file) => {
+            if (file.field_id) {
+              if (!filesByFieldId.has(file.field_id)) {
+                filesByFieldId.set(file.field_id, []);
+              }
+              filesByFieldId.get(file.field_id).push(file.id);
+            }
+          });
+          fileFields.forEach((field) => {
+            const fileIds = filesByFieldId.get(field.id) || [];
+            if (fileIds.length > 0 || !transformedInstance.data[field.name]) {
+              transformedInstance.data[field.name] = fileIds;
+            }
+          });
+        }
+      }
+      const instanceWithRelations = __spreadProps(__spreadValues({}, transformedInstance), {
+        relations: Object.keys(relations).length > 0 ? relations : void 0
+      });
+      return flattenInstance(
+        instanceWithRelations,
+        fields.map((f) => ({ name: f.name, dbType: f.dbType })),
+        (_a = params == null ? void 0 : params.relationsAsIds) != null ? _a : false
+      );
+    } catch (error) {
+      if (error instanceof NotFoundError || error instanceof PermissionDeniedError || error instanceof ValidationError || error instanceof SDKError) {
+        throw error;
+      }
+      handleSupabaseError(error);
+    }
+  }
   /**
    * Получить список экземпляров
    * Поддерживает поиск, фильтры (JSONB и relation), пагинацию