@kinotic-ai/os-api 1.0.15 → 1.1.0

package/dist/index.cjs

@@ -71,6 +71,7 @@ __export(exports_src, {
   LoggerLevelsDescriptor: () => LoggerLevelsDescriptor,
   LogManager: () => LogManager,
   LogLevel: () => LogLevel,
+  KinoticProjectConfig: () => KinoticProjectConfig,
   IdDecorator: () => IdDecorator,
   IamUserService: () => IamUserService,
   IamUser: () => IamUser,
@@ -297,6 +298,7 @@ var ProjectType;
 // packages/os-api/src/api/model/EntityDefinition.ts
 class EntityDefinition {
   id;
+  organizationId;
   applicationId;
   projectId;
   name;
@@ -306,7 +308,8 @@ class EntityDefinition {
   updated;
   published;
   publishedTimestamp;
-  constructor(applicationId, projectId, name, schema, description) {
+  constructor(organizationId, applicationId, projectId, name, schema, description) {
+    this.organizationId = organizationId;
     this.applicationId = applicationId;
     this.projectId = projectId;
     this.name = name;
@@ -317,6 +320,7 @@ class EntityDefinition {
 // packages/os-api/src/api/model/NamedQueriesDefinition.ts
 class NamedQueriesDefinition {
   id;
+  organizationId;
   applicationId;
   projectId;
   entityDefinitionName;
@@ -427,6 +431,17 @@ class IamUser {
   created = null;
   updated = null;
 }
+// packages/os-api/src/api/model/KinoticProjectConfig.ts
+class KinoticProjectConfig {
+  name;
+  description;
+  organization;
+  application;
+  entitiesPaths;
+  generatedPath;
+  fileExtensionForImports = ".js";
+  validate;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 var import_core = require("@kinotic-ai/core");
 

package/dist/index.d.cts

@@ -180,6 +180,11 @@ import { Identifiable as Identifiable3 } from "@kinotic-ai/core";
 declare class EntityDefinition implements Identifiable3<string> {
 	id: string | null;
 	/**
+	* The id of the organization that owns this entity definition.
+	* Populated server-side by org enforcement on save.
+	*/
+	organizationId: string;
+	/**
 	* The id of the application that this entity definition belongs to.
 	* All application ids are unique throughout the entire system.
 	*/
@@ -196,7 +201,7 @@ declare class EntityDefinition implements Identifiable3<string> {
 	updated: number;
 	published: boolean;
 	publishedTimestamp: number;
-	constructor(applicationId: string, projectId: string, name: string, schema: ObjectC3Type3, description?: string | null);
+	constructor(organizationId: string, applicationId: string, projectId: string, name: string, schema: ObjectC3Type3, description?: string | null);
 }
 import { Identifiable as Identifiable4 } from "@kinotic-ai/core";
 import { FunctionDefinition } from "@kinotic-ai/idl";
@@ -205,6 +210,7 @@ import { FunctionDefinition } from "@kinotic-ai/idl";
 */
 declare class NamedQueriesDefinition implements Identifiable4<string> {
 	id: string;
+	organizationId?: string | null;
 	applicationId: string;
 	projectId: string;
 	entityDefinitionName: string;
@@ -528,6 +534,70 @@ interface SignUpCompleteRequest {
 	token: string;
 	password: string;
 }
+/**
+* Configuration for a single entities path and its corresponding repository output.
+*/
+type EntitiesPathConfig = {
+	/**
+	* The path to search for classes decorated with @Entity.
+	*/
+	path: string;
+	/**
+	* The path where generated Repository classes will be placed.
+	*/
+	repositoryPath: string;
+	/**
+	* If true, the subfolder structure under the entities path will be mirrored under the repository path.
+	* For example, if entitiesPath is "src/model" and contains "payments/Payment.ts",
+	* the generated repository will be placed in "repositoryPath/payments/".
+	* If false, all generated repositories are placed directly in the repositoryPath.
+	* Defaults to true.
+	*/
+	mirrorFolderStructure?: boolean;
+};
+/**
+* The project configuration for a Kinotic project.
+*/
+declare class KinoticProjectConfig {
+	/**
+	* The name of the project or undefined if a project name is used.
+	* i.e. if the project is typescript the package.json name will be used.
+	*/
+	name?: string;
+	/**
+	* The description of the project.
+	*/
+	description?: string;
+	/**
+	* The Kinotic Organization that this project belongs to.
+	*/
+	organization: string;
+	/**
+	* The Kinotic Application that this project belongs to.
+	*/
+	application: string;
+	/**
+	* The paths to search for classes decorated with @Entity that Kinotic will be created for.
+	* Each entry can be a string (simple path) or an {@link EntitiesPathConfig} object for full control
+	* over where repository classes are generated.
+	*
+	* When a plain string is provided, the {@link generatedPath} will be used as the repository output path.
+	*/
+	entitiesPaths: (string | EntitiesPathConfig)[];
+	/**
+	* The default path to where generated files will be placed when entitiesPaths contains plain strings.
+	* Ignored for entitiesPaths entries that use {@link EntitiesPathConfig}.
+	*/
+	generatedPath?: string;
+	/**
+	* The file extension to use for imports in generated files.
+	*/
+	fileExtensionForImports: string;
+	/**
+	* If true the generated Repository classes will validate all data before sending to the server.
+	*/
+	validate?: boolean;
+}
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -880,4 +950,4 @@ declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };
+export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.d.ts

@@ -180,6 +180,11 @@ import { Identifiable as Identifiable3 } from "@kinotic-ai/core";
 declare class EntityDefinition implements Identifiable3<string> {
 	id: string | null;
 	/**
+	* The id of the organization that owns this entity definition.
+	* Populated server-side by org enforcement on save.
+	*/
+	organizationId: string;
+	/**
 	* The id of the application that this entity definition belongs to.
 	* All application ids are unique throughout the entire system.
 	*/
@@ -196,7 +201,7 @@ declare class EntityDefinition implements Identifiable3<string> {
 	updated: number;
 	published: boolean;
 	publishedTimestamp: number;
-	constructor(applicationId: string, projectId: string, name: string, schema: ObjectC3Type3, description?: string | null);
+	constructor(organizationId: string, applicationId: string, projectId: string, name: string, schema: ObjectC3Type3, description?: string | null);
 }
 import { Identifiable as Identifiable4 } from "@kinotic-ai/core";
 import { FunctionDefinition } from "@kinotic-ai/idl";
@@ -205,6 +210,7 @@ import { FunctionDefinition } from "@kinotic-ai/idl";
 */
 declare class NamedQueriesDefinition implements Identifiable4<string> {
 	id: string;
+	organizationId?: string | null;
 	applicationId: string;
 	projectId: string;
 	entityDefinitionName: string;
@@ -528,6 +534,70 @@ interface SignUpCompleteRequest {
 	token: string;
 	password: string;
 }
+/**
+* Configuration for a single entities path and its corresponding repository output.
+*/
+type EntitiesPathConfig = {
+	/**
+	* The path to search for classes decorated with @Entity.
+	*/
+	path: string;
+	/**
+	* The path where generated Repository classes will be placed.
+	*/
+	repositoryPath: string;
+	/**
+	* If true, the subfolder structure under the entities path will be mirrored under the repository path.
+	* For example, if entitiesPath is "src/model" and contains "payments/Payment.ts",
+	* the generated repository will be placed in "repositoryPath/payments/".
+	* If false, all generated repositories are placed directly in the repositoryPath.
+	* Defaults to true.
+	*/
+	mirrorFolderStructure?: boolean;
+};
+/**
+* The project configuration for a Kinotic project.
+*/
+declare class KinoticProjectConfig {
+	/**
+	* The name of the project or undefined if a project name is used.
+	* i.e. if the project is typescript the package.json name will be used.
+	*/
+	name?: string;
+	/**
+	* The description of the project.
+	*/
+	description?: string;
+	/**
+	* The Kinotic Organization that this project belongs to.
+	*/
+	organization: string;
+	/**
+	* The Kinotic Application that this project belongs to.
+	*/
+	application: string;
+	/**
+	* The paths to search for classes decorated with @Entity that Kinotic will be created for.
+	* Each entry can be a string (simple path) or an {@link EntitiesPathConfig} object for full control
+	* over where repository classes are generated.
+	*
+	* When a plain string is provided, the {@link generatedPath} will be used as the repository output path.
+	*/
+	entitiesPaths: (string | EntitiesPathConfig)[];
+	/**
+	* The default path to where generated files will be placed when entitiesPaths contains plain strings.
+	* Ignored for entitiesPaths entries that use {@link EntitiesPathConfig}.
+	*/
+	generatedPath?: string;
+	/**
+	* The file extension to use for imports in generated files.
+	*/
+	fileExtensionForImports: string;
+	/**
+	* If true the generated Repository classes will validate all data before sending to the server.
+	*/
+	validate?: boolean;
+}
 import { IKinotic } from "@kinotic-ai/core";
 import { CrudServiceProxy, ICrudServiceProxy } from "@kinotic-ai/core";
 interface IApplicationService extends ICrudServiceProxy<Application> {
@@ -880,4 +950,4 @@ declare const OsApiPlugin: KinoticPlugin<IOsApiExtension>;
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };
+export { WorkloadStatus, WorkloadServiceProxy, Workload, VmProviderType, VmNodeStatus, VmNodeServiceProxy, VmNode, VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, SignUpRequest, SignUpCompleteRequest, QueryOptionsC3Type, QueryDecorator, ProjectType, ProjectService, Project, ProgressType, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticProjectConfig, InsightRequest, InsightProgress, IdDecorator, IamUserService, IamUser, IWorkloadService, IVmNodeService, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IIamUserService, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntitiesPathConfig, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, AuthType, ApplicationService, Application };

package/dist/index.js

@@ -206,6 +206,7 @@ var ProjectType;
 // packages/os-api/src/api/model/EntityDefinition.ts
 class EntityDefinition {
   id;
+  organizationId;
   applicationId;
   projectId;
   name;
@@ -215,7 +216,8 @@ class EntityDefinition {
   updated;
   published;
   publishedTimestamp;
-  constructor(applicationId, projectId, name, schema, description) {
+  constructor(organizationId, applicationId, projectId, name, schema, description) {
+    this.organizationId = organizationId;
     this.applicationId = applicationId;
     this.projectId = projectId;
     this.name = name;
@@ -226,6 +228,7 @@ class EntityDefinition {
 // packages/os-api/src/api/model/NamedQueriesDefinition.ts
 class NamedQueriesDefinition {
   id;
+  organizationId;
   applicationId;
   projectId;
   entityDefinitionName;
@@ -336,6 +339,17 @@ class IamUser {
   created = null;
   updated = null;
 }
+// packages/os-api/src/api/model/KinoticProjectConfig.ts
+class KinoticProjectConfig {
+  name;
+  description;
+  organization;
+  application;
+  entitiesPaths;
+  generatedPath;
+  fileExtensionForImports = ".js";
+  validate;
+}
 // packages/os-api/src/api/services/IApplicationService.ts
 import { CrudServiceProxy } from "@kinotic-ai/core";
 
@@ -613,6 +627,7 @@ export {
   LoggerLevelsDescriptor,
   LogManager,
   LogLevel,
+  KinoticProjectConfig,
   IdDecorator,
   IamUserService,
   IamUser,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinotic-ai/os-api",
-  "version": "1.0.15",
+  "version": "1.1.0",
   "type": "module",
   "files": [
     "dist"
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@kinotic-ai/idl": "1.0.9",
-    "@kinotic-ai/persistence": "1.1.0",
+    "@kinotic-ai/persistence": "1.2.0",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {