@ldsg/object 0.3.31 → 0.3.33

package/dist/__tests__/unit.js

@@ -1,88 +1,93 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const constants_1 = require("@ldsg/constants");
 const field_type_1 = require("@ldsg/field-type");
 const handler_1 = require("@ldsg/handler");
 const resource_1 = require("@ldsg/resource");
+const lodash_1 = __importDefault(require("lodash"));
 const resource_2 = require("../resource");
 class MockObjectFieldResource extends resource_1.Resource {
     constructor() {
         super(...arguments);
         this.getFieldInfo = (params) => {
-            const { id, settings: { title, description, name, properties }, getResourcesFromSettings } = this;
+            const { id, settings: { title, description, slug, properties }, getResourcesFromSettings, } = this;
             const { fieldTypeResource } = getResourcesFromSettings();
             const { fieldTypeInfo } = fieldTypeResource.getFieldTypeInfo({
                 ...params,
-                fieldProperties: properties
+                fieldProperties: properties,
             });
             const fieldInfo = {
                 id,
                 title,
                 description,
-                name,
-                typeInfo: fieldTypeInfo
+                name: lodash_1.default.camelCase(slug),
+                dbKey: lodash_1.default.snakeCase(slug),
+                typeInfo: fieldTypeInfo,
             };
             const res = {
-                fieldInfo
+                fieldInfo,
             };
             return res;
         };
     }
 }
-test('object', () => {
+test("object", () => {
     new handler_1.HandlerResource(field_type_1.stringFieldTypeHandlerResourceRecord);
     new field_type_1.FieldTypeResource(field_type_1.stringFieldTypeResourceRecord);
     const testObject = new resource_2.ObjectResource({
-        id: 'test-object',
-        kind: 'object',
+        id: "test-object",
+        kind: "object",
         parentId: constants_1.ROOT_RESOURCE_ID,
         settings: {
-            title: '测试对象',
-            description: '',
-            name: 'test'
-        }
+            title: "测试对象",
+            description: "",
+            slug: "test",
+        },
     });
     new MockObjectFieldResource({
-        id: 'test-object-test-1-object-field',
-        kind: 'object_field',
-        parentId: 'test-object',
+        id: "test-object-test-1-object-field",
+        kind: "object_field",
+        parentId: "test-object",
         settings: {
-            title: '测试对象测试1对象字段',
-            description: '',
-            name: 'test1',
+            title: "测试对象测试1对象字段",
+            description: "",
+            slug: "test1",
             fieldTypeResourceId: field_type_1.stringFieldTypeResourceRecord.id,
             properties: {
-                max: '10'
-            }
-        }
+                max: "10",
+            },
+        },
     });
     new MockObjectFieldResource({
-        id: 'test-object-test-2-object-field',
-        kind: 'object_field',
-        parentId: 'test-object',
+        id: "test-object-test-2-object-field",
+        kind: "object_field",
+        parentId: "test-object",
         settings: {
-            title: '测试对象测试2对象字段',
-            description: '',
-            name: 'test2',
+            title: "测试对象测试2对象字段",
+            description: "",
+            slug: "test2",
             fieldTypeResourceId: field_type_1.stringFieldTypeResourceRecord.id,
             properties: {
-                max: '10'
-            }
-        }
+                max: "10",
+            },
+        },
     });
     new MockObjectFieldResource({
-        id: 'test-object-test-3-object-field',
-        kind: 'object_field',
-        parentId: 'test-object',
+        id: "test-object-test-3-object-field",
+        kind: "object_field",
+        parentId: "test-object",
         settings: {
-            title: '测试对象测试3对象字段',
-            description: '',
-            name: 'test3',
+            title: "测试对象测试3对象字段",
+            description: "",
+            slug: "test3",
             fieldTypeResourceId: field_type_1.stringFieldTypeResourceRecord.id,
             properties: {
-                max: '10'
-            }
-        }
+                max: "10",
+            },
+        },
     });
     const getObjectInfoRes = testObject.getObjectInfo();
     expect(getObjectInfoRes).toMatchSnapshot();

package/dist/constants.d.ts

@@ -1,6 +1,6 @@
-import { HandlerSpecificResourceSettings } from '@ldsg/handler';
-import { ResourceDefinitionSpecificResourceSettings } from '@ldsg/resource-definition';
-import { GeneralResourceSettings } from '@ldsg/types';
+import { HandlerSpecificResourceSettings } from "@ldsg/handler";
+import { ResourceDefinitionSpecificResourceSettings } from "@ldsg/resource-definition";
+import { GeneralResourceSettings } from "@ldsg/types";
 /**
  * Instantiate Resource Handler General Resource Settings
  * 实例化资源处理程序普通资源配置

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,0CAA0C,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,sDAAsD,EAAE,uBAGpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uDAAuD,EAAE,+BAOrE,CAAC;AAEF,eAAO,MAAM,6CAA6C,EAAE,uBAG3D,CAAC;AAEF,eAAO,MAAM,8CAA8C,EAAE,0CAE5D,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,0CAA0C,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,sDAAsD,EAAE,uBAGpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uDAAuD,EAAE,+BAQnE,CAAC;AAEJ,eAAO,MAAM,6CAA6C,EAAE,uBAG3D,CAAC;AAEF,eAAO,MAAM,8CAA8C,EAAE,0CAG1D,CAAC"}

package/dist/constants.js

@@ -6,8 +6,8 @@ exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = exports.RESOURCE_DEFINI
  * 实例化资源处理程序普通资源配置
  */
 exports.INSTANTIATE_RESOURCE_HANDLER_GENERAL_RESOURCE_SETTINGS = {
-    title: '对象实例化资源处理程序',
-    description: ''
+    title: "对象实例化资源处理程序",
+    description: "",
 };
 /**
  * Instantiate Resource Handler Specific Resource Settings
@@ -18,14 +18,14 @@ exports.INSTANTIATE_RESOURCE_HANDLER_SPECIFIC_RESOURCE_SETTINGS = {
     code: `export * from "@ldsg/object";`,
     dependencies: [
         {
-            name: '@ldsg/object'
-        }
-    ]
+            name: "@ldsg/object",
+        },
+    ],
 };
 exports.RESOURCE_DEFINITION_GENERAL_RESOURCE_SETTINGS = {
-    title: '对象资源定义',
-    description: ''
+    title: "对象资源定义",
+    description: "",
 };
 exports.RESOURCE_DEFINITION_SPECIFIC_RESOURCE_SETTINGS = {
-    kind: 'object'
+    kind: "object",
 };

package/dist/handler.d.ts

@@ -1,6 +1,6 @@
-import { Handler, HandlerExtendedResourceSettings } from '@ldsg/handler';
-import { InstantiateResourceParams, InstantiateResourceRes } from '@ldsg/resource';
-import { ObjectResource } from './resource';
-import { ObjectSpecificResourceSettings } from './types';
+import { Handler, HandlerExtendedResourceSettings } from "@ldsg/handler";
+import { InstantiateResourceParams, InstantiateResourceRes } from "@ldsg/resource";
+import { ObjectResource } from "./resource";
+import { ObjectSpecificResourceSettings } from "./types";
 export declare const handler: Handler<InstantiateResourceParams<HandlerExtendedResourceSettings<ObjectSpecificResourceSettings>>, InstantiateResourceRes<ObjectResource>>;
 //# sourceMappingURL=handler.d.ts.map

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export * from './constants';
-export * from './handler';
-export * from './instantiate-resource';
-export * from './resource';
-export * from './types';
+export * from "./constants";
+export * from "./handler";
+export * from "./instantiate-resource";
+export * from "./resource";
+export * from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/instantiate-resource.d.ts

@@ -1,6 +1,6 @@
-import { HandlerExtendedResourceSettings } from '@ldsg/handler';
-import { InstantiateResource } from '@ldsg/resource';
-import { ObjectResource } from './resource';
-import { ObjectSpecificResourceSettings } from './types';
+import { HandlerExtendedResourceSettings } from "@ldsg/handler";
+import { InstantiateResource } from "@ldsg/resource";
+import { ObjectResource } from "./resource";
+import { ObjectSpecificResourceSettings } from "./types";
 export declare const instantiateResource: InstantiateResource<HandlerExtendedResourceSettings<ObjectSpecificResourceSettings>, ObjectResource>;
 //# sourceMappingURL=instantiate-resource.d.ts.map

package/dist/instantiate-resource.js

@@ -6,7 +6,7 @@ const instantiateResource = (params) => {
     const { resourceConstructorParams } = params;
     const resource = new resource_1.ObjectResource(resourceConstructorParams);
     const res = {
-        resource
+        resource,
     };
     return res;
 };

package/dist/resource.d.ts

@@ -1,12 +1,18 @@
-import { PlatformsParams } from '@ldsg/field-type';
-import { Resource } from '@ldsg/resource';
-import { GeneralResourceSettings } from '@ldsg/types';
-import { FieldInfo, ObjectSpecificResourceSettings } from './types';
+import { PlatformsParams } from "@ldsg/field-type";
+import { Resource } from "@ldsg/resource";
+import { GeneralResourceSettings } from "@ldsg/types";
+import { FieldInfo, ObjectSpecificResourceSettings } from "./types";
 export interface ObjectInfo extends GeneralResourceSettings {
     /**
      * Object Name
+     * camel case
      */
     name: string;
+    /**
+     * Object Type Name
+     * pascal case
+     */
+    objectTypeName: string;
     /**
      * Field Info List
      */

package/dist/resource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAgB,8BAA8B,EAAE,MAAM,SAAS,CAAC;AAElF,MAAM,WAAW,UAAW,SAAQ,uBAAuB;IACzD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,SAAS,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,KAAK,aAAa,GAAG,CAAC,MAAM,CAAC,EAAE,eAAe,KAAK,gBAAgB,CAAC;AAEpE,qBAAa,cAAe,SAAQ,QAAQ,CAAC,8BAA8B,CAAC;IAC1E,aAAa,EAAE,aAAa,CAiC1B;CACH"}
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAgB,8BAA8B,EAAE,MAAM,SAAS,CAAC;AAElF,MAAM,WAAW,UAAW,SAAQ,uBAAuB;IACzD;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,SAAS,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,KAAK,aAAa,GAAG,CAAC,MAAM,CAAC,EAAE,eAAe,KAAK,gBAAgB,CAAC;AAEpE,qBAAa,cAAe,SAAQ,QAAQ,CAAC,8BAA8B,CAAC;IAC1E,aAAa,EAAE,aAAa,CAsC1B;CACH"}

package/dist/resource.js

@@ -10,9 +10,11 @@ class ObjectResource extends resource_1.Resource {
     constructor() {
         super(...arguments);
         this.getObjectInfo = (params) => {
-            const { id, settings: { title, description, name }, getFilteredResources } = this;
+            const { id, settings: { title, description, slug }, getFilteredResources, } = this;
+            const name = lodash_1.default.camelCase(slug);
+            const objectTypeName = lodash_1.default.upperFirst(lodash_1.default.camelCase(slug));
             const { resources } = getFilteredResources({
-                parentId: id
+                parentId: id,
             });
             const mapRes = resources.map((resource) => {
                 var _a;
@@ -20,15 +22,16 @@ class ObjectResource extends resource_1.Resource {
                 return fieldInfo;
             });
             const filterRes = lodash_1.default.filter(mapRes, (value) => !lodash_1.default.isUndefined(value));
-            const fieldInfoList = lodash_1.default.map(filterRes, 'fieldInfo');
+            const fieldInfoList = lodash_1.default.map(filterRes, "fieldInfo");
             const objectInfo = {
                 title,
                 description,
                 name,
-                fieldInfoList
+                objectTypeName,
+                fieldInfoList,
             };
             const res = {
-                objectInfo
+                objectInfo,
             };
             return res;
         };

package/dist/types/get-field-info.d.ts

@@ -1,14 +1,20 @@
-import { FieldTypeInfo, PlatformsParams } from '@ldsg/field-type';
-import { GeneralResourceSettings } from '@ldsg/types';
+import { FieldTypeInfo, PlatformsParams } from "@ldsg/field-type";
+import { GeneralResourceSettings } from "@ldsg/types";
 export interface FieldInfo extends GeneralResourceSettings {
     /**
      * Field ID
      */
     id: string;
     /**
-     * Field Name
+     * Field name (camelCase, e.g. "userId")
+     * Used as the GraphQL field name / Mongoose alias.
      */
     name: string;
+    /**
+     * Database field key (snake_case, e.g. "user_id")
+     * Used as the MongoDB document field key.
+     */
+    dbKey: string;
     /**
      * Field Type Info
      */
@@ -21,6 +27,6 @@ export interface FieldInfo extends GeneralResourceSettings {
 interface GetFieldInfoRes {
     fieldInfo: FieldInfo;
 }
-export type GetFieldInfo = (params?: PlatformsParams) => GetFieldInfoRes;
+export type GetFieldInfo = (params?: PlatformsParams) => GetFieldInfoRes | undefined;
 export {};
 //# sourceMappingURL=get-field-info.d.ts.map

package/dist/types/get-field-info.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-field-info.d.ts","sourceRoot":"","sources":["../../src/types/get-field-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD,MAAM,WAAW,SAAU,SAAQ,uBAAuB;IACxD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;CAC7B;AAED,UAAU,eAAe;IACvB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,eAAe,KAAK,eAAe,CAAC"}
+{"version":3,"file":"get-field-info.d.ts","sourceRoot":"","sources":["../../src/types/get-field-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD,MAAM,WAAW,SAAU,SAAQ,uBAAuB;IACxD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;CAC7B;AAED,UAAU,eAAe;IACvB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,eAAe,KAAK,eAAe,GAAG,SAAS,CAAC"}

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from './get-field-info';
-export * from './specific-resource-settings';
+export * from "./get-field-info";
+export * from "./specific-resource-settings";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/specific-resource-settings.d.ts

@@ -1,9 +1,9 @@
-import { z } from 'zod';
+import { z } from "zod";
 export declare const ObjectSpecificResourceSettingsSchema: z.ZodObject<{
-    name: z.ZodString;
+    slug: z.ZodString;
 }, z.core.$catchall<z.ZodAny>>;
 export declare const SpecificResourceSettingsSchema: z.ZodObject<{
-    name: z.ZodString;
+    slug: z.ZodString;
 }, z.core.$catchall<z.ZodAny>>;
 export type ObjectSpecificResourceSettings = z.infer<typeof ObjectSpecificResourceSettingsSchema>;
 //# sourceMappingURL=specific-resource-settings.d.ts.map

package/dist/types/specific-resource-settings.js

@@ -5,9 +5,9 @@ const zod_1 = require("zod");
 exports.ObjectSpecificResourceSettingsSchema = zod_1.z
     .object({
     /**
-     * Object Name
+     * Object Slug
      */
-    name: zod_1.z.string()
+    slug: zod_1.z.string(),
 })
     .catchall(zod_1.z.any());
 exports.SpecificResourceSettingsSchema = exports.ObjectSpecificResourceSettingsSchema;

package/package.json

@@ -1,40 +1,44 @@
 {
   "name": "@ldsg/object",
-  "version": "0.3.31",
+  "version": "0.3.33",
   "description": "",
   "keywords": [],
   "license": "MIT",
   "author": "wanxger",
-  "main": "dist/index.js",
-  "types": "dist",
   "files": [
     "dist/"
   ],
+  "main": "dist/index.js",
+  "types": "dist",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "lodash": "^4.17.21",
     "zod": "^4.1.11",
-    "@ldsg/constants": "0.3.31",
-    "@ldsg/handler": "0.3.31",
-    "@ldsg/resource": "0.3.31",
-    "@ldsg/resource-definition": "0.3.31"
+    "@ldsg/constants": "0.3.33",
+    "@ldsg/handler": "0.3.33",
+    "@ldsg/resource": "0.3.33",
+    "@ldsg/resource-definition": "0.3.33"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",
     "@types/lodash": "^4.14.202",
     "jest": "^29.5.0",
+    "oxfmt": "latest",
+    "oxlint": "latest",
     "supertest": "^6.3.4",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
-    "@ldsg/field-type": "0.3.31",
-    "@ldsg/types": "0.3.31"
-  },
-  "publishConfig": {
-    "access": "public"
+    "@ldsg/field-type": "0.3.33",
+    "@ldsg/types": "0.3.33"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "clean": "rm -rf dist",
+    "format": "oxfmt --write src/",
+    "lint": "oxlint src/",
     "test": "jest"
   }
 }