@kinotic-ai/os-api 1.0.2 → 1.0.3

package/dist/index.cjs

@@ -41,9 +41,6 @@ var __export = (target, all) => {
 var exports_src = {};
 __export(exports_src, {
   VersionDecorator: () => VersionDecorator,
-  TypescriptProjectConfig: () => TypescriptProjectConfig,
-  TypescriptExternalProjectConfig: () => TypescriptExternalProjectConfig,
-  TransformConfiguration: () => TransformConfiguration,
   TimeReferenceDecorator: () => TimeReferenceDecorator,
   TextDecorator: () => TextDecorator,
   TenantSelectionC3Type: () => TenantSelectionC3Type,
@@ -59,7 +56,6 @@ __export(exports_src, {
   PolicyDecorator: () => PolicyDecorator,
   PageableC3Type: () => PageableC3Type,
   PageC3Type: () => PageC3Type,
-  OverrideConfiguration: () => OverrideConfiguration,
   OsApiPlugin: () => OsApiPlugin,
   NotIndexedDecorator: () => NotIndexedDecorator,
   NestedDecorator: () => NestedDecorator,
@@ -71,7 +67,6 @@ __export(exports_src, {
   LogManager: () => LogManager,
   LogLevel: () => LogLevel,
   KinoticSingleton: () => import_core5.KinoticSingleton,
-  KinoticProjectConfig: () => KinoticProjectConfig,
   Kinotic: () => import_core5.Kinotic,
   IdDecorator: () => IdDecorator,
   GroupLoggerLevelsDescriptor: () => GroupLoggerLevelsDescriptor,
@@ -80,10 +75,8 @@ __export(exports_src, {
   EntityDefinitionService: () => EntityDefinitionService,
   EntityDefinition: () => EntityDefinition,
   EntityDecorator: () => EntityDecorator,
-  EntityConfiguration: () => EntityConfiguration,
   DiscriminatorDecorator: () => DiscriminatorDecorator,
   DataInsightsService: () => DataInsightsService,
-  CalculatedPropertyConfiguration: () => CalculatedPropertyConfiguration,
   AutoGeneratedIdDecorator: () => AutoGeneratedIdDecorator,
   ApplicationService: () => ApplicationService,
   Application: () => Application,
@@ -365,53 +358,6 @@ class NamedQueriesDefinition {
     this.namedQueries = namedQueries;
   }
 }
-// packages/os-api/src/api/model/config/CalculatedPropertyConfiguration.ts
-class CalculatedPropertyConfiguration {
-  entityJsonPath;
-  propertyName;
-  calculatedPropertyFunctionName;
-  decorators;
-}
-// packages/os-api/src/api/model/config/EntityConfiguration.ts
-class EntityConfiguration {
-  entityName;
-  multiTenancyType;
-  excludeJsonPaths;
-  overrides;
-  transforms;
-  calculatedProperties;
-}
-// packages/os-api/src/api/model/config/OverrideConfiguration.ts
-class OverrideConfiguration {
-  jsonPath;
-  propertyDefinition;
-}
-// packages/os-api/src/api/model/config/KinoticProjectConfig.ts
-class KinoticProjectConfig {
-  mdl;
-  name;
-  description;
-  application;
-  entitiesPaths;
-  generatedPath;
-  fileExtensionForImports = ".js";
-  validate;
-}
-
-class TypescriptProjectConfig extends KinoticProjectConfig {
-  mdl = "ts";
-}
-
-class TypescriptExternalProjectConfig extends KinoticProjectConfig {
-  mdl = "ts-external";
-  externalEntities;
-  utilFunctionsPaths;
-}
-// packages/os-api/src/api/model/config/TransformConfiguration.ts
-class TransformConfiguration {
-  jsonPath;
-  transformerFunctionName;
-}
 // packages/os-api/src/api/model/insights/InsightProgress.ts
 var ProgressType;
 ((ProgressType2) => {

package/dist/index.d.cts

@@ -264,162 +264,6 @@ interface MigrationResult {
 	errorMessage?: string;
 	migrationsProcessed: number;
 }
-import { C3Decorator as C3Decorator14 } from "@kinotic-ai/idl";
-declare class CalculatedPropertyConfiguration {
-	/**
-	* The json path to the Entity that this property will be calculated for.
-	* If this is the root Entity then this should be and empty string.
-	*/
-	entityJsonPath: string;
-	/**
-	* The name of the property that will be calculated and added to the given Entity.
-	*/
-	propertyName: string;
-	/**
-	* The name of the function that will be used to calculate the value for the property.
-	*/
-	calculatedPropertyFunctionName: string;
-	/**
-	* Any decorators that should be applied to the calculated property.
-	* These will be added to the {@link C3Type} that is created for the Entity.
-	*/
-	decorators?: C3Decorator14[];
-}
-import { MultiTenancyType as MultiTenancyType2 } from "@kinotic-ai/persistence";
-import { PropertyDefinition } from "@kinotic-ai/idl";
-/**
-* The configuration for a property that should be overridden.
-* This allows you to specify a static {@link PropertyDefinition} for a property.
-*/
-declare class OverrideConfiguration {
-	/**
-	* The json path to the property that should be overridden.
-	*/
-	jsonPath: string;
-	/**
-	* The {@link PropertyDefinition} that should be used for the property.
-	*/
-	propertyDefinition: PropertyDefinition;
-}
-/**
-* The configuration for a function that will transform a value before it is sent to the server.
-* The function must be exported from a file that is specified in {@link TypescriptExternalProjectConfig.utilFunctionsPaths}
-* The function return argument will be the resulting {@link C3Type} that will be configured for the Entity
-*/
-declare class TransformConfiguration {
-	/**
-	* The json path to the property that should be transformed.
-	* There must only be one {@link TransformConfiguration} per jsonPath.
-	*/
-	jsonPath: string;
-	/**
-	* The name of the function that will be used to transform the value.
-	*/
-	transformerFunctionName: string;
-}
-/**
-* The configuration for an External Entity.
-* This allows you to specify an Entity that is part of an external codebase.
-*/
-declare class EntityConfiguration {
-	/**
-	* The name of the Entity that will be used to create the Structure.
-	*/
-	entityName: string;
-	/**
-	* The multi tenancy type for this Entity.
-	*/
-	multiTenancyType: MultiTenancyType2;
-	/**
-	* Json paths to properties that should be excluded from the Entity.
-	* These have a higher priority than {@link OverrideConfiguration} and {@link TransformConfiguration}
-	*/
-	excludeJsonPaths?: string[];
-	/**
-	* Array of {@link OverrideConfiguration} that should be applied to the Entity.
-	* These have a higher priority than {@link TransformConfiguration}s
-	*/
-	overrides?: OverrideConfiguration[];
-	/**
-	* Array of {@link TransformConfiguration} that should be applied to the Entity.
-	* These have a lower priority than {@link OverrideConfiguration}s.
-	*/
-	transforms?: TransformConfiguration[];
-	/**
-	* Array of {@link CalculatedPropertyConfiguration} that should be applied to the Entity.
-	* The calculated property function will be called for every instance of the Entity.
-	* And is passed the instance of the Entity as the first argument.
-	* And the json path as the second argument.
-	* These have the highest priority.
-	*/
-	calculatedProperties?: CalculatedPropertyConfiguration[];
-}
-/**
-* The project configuration for a structures project.
-* This is the base configuration. Language specific configurations extend this configuration.
-*/
-declare abstract class KinoticProjectConfig {
-	/**
-	* This specifies the Model Definition Language (MDL).
-	* This is the language that is used to define the structures models.
-	* The following values are supported:
-	* - ts: TypeScript
-	* - ts-external: TypeScript with external models (defined by an external package)
-	* - gql: GraphQL
-	*/
-	mdl: "ts" | "ts-external" | "gql";
-	/**
-	* The name of the project or undefined if a language specific 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 Structures Application that this project belongs to.
-	*/
-	application: string;
-	/**
-	* The paths to search for classes decorated with @Entity that Structures will be created for.
-	*/
-	entitiesPaths: string[];
-	/**
-	* The path to where generated files will be placed.
-	*/
-	generatedPath: string;
-	/**
-	* The file extension to use for imports in generated files.
-	*/
-	fileExtensionForImports: string;
-	/**
-	* If true the generated EntityService classes will validate all data before sending to the server.
-	*/
-	validate?: boolean;
-}
-/**
-* The project configuration for a TypeScript structures project.
-*/
-declare class TypescriptProjectConfig extends KinoticProjectConfig {
-	readonly mdl = "ts";
-}
-/**
-* The project configuration for a TypeScript structures project.
-*/
-declare class TypescriptExternalProjectConfig extends KinoticProjectConfig {
-	readonly mdl = "ts-external";
-	/**
-	* External EntityConfigurations that are part of an external codebase and that you cannot add @Entity decorators to.
-	*/
-	externalEntities?: {
-		[pathPattern: string]: EntityConfiguration[];
-	};
-	/**
-	* The path to look for files that functions that can be used by a {@link TransformConfiguration} or {@link CalculatedPropertyConfiguration}.
-	*/
-	utilFunctionsPaths?: string[];
-}
 /**
 * Represents an individual web component generated by the data insights system.
 * Each component is a self-contained visualization that can be dropped into any page.
@@ -791,4 +635,4 @@ import { Kinotic, KinoticSingleton as KinoticSingleton2, IKinotic as IKinotic8,
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { VersionDecorator, TypescriptProjectConfig, TypescriptExternalProjectConfig, TransformConfiguration, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, RoleDecorator, QueryOptionsC3Type, QueryDecorator, ProjectType2 as ProjectType, ProjectService, Project, ProgressType, PolicyDecorator, PageableC3Type, PageC3Type, OverrideConfiguration, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticSingleton2 as KinoticSingleton, KinoticProjectConfig, KinoticPlugin2 as KinoticPlugin, Kinotic, InsightRequest, InsightProgress, IdDecorator, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IKinotic8 as IKinotic, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntityConfiguration, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, CalculatedPropertyConfiguration, AutoGeneratedIdDecorator, ApplicationService, Application, $Role, $Policy };
+export { VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, RoleDecorator, QueryOptionsC3Type, QueryDecorator, ProjectType2 as ProjectType, ProjectService, Project, ProgressType, PolicyDecorator, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticSingleton2 as KinoticSingleton, KinoticPlugin2 as KinoticPlugin, Kinotic, InsightRequest, InsightProgress, IdDecorator, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IKinotic8 as IKinotic, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, ApplicationService, Application, $Role, $Policy };

package/dist/index.d.ts

@@ -264,162 +264,6 @@ interface MigrationResult {
 	errorMessage?: string;
 	migrationsProcessed: number;
 }
-import { C3Decorator as C3Decorator14 } from "@kinotic-ai/idl";
-declare class CalculatedPropertyConfiguration {
-	/**
-	* The json path to the Entity that this property will be calculated for.
-	* If this is the root Entity then this should be and empty string.
-	*/
-	entityJsonPath: string;
-	/**
-	* The name of the property that will be calculated and added to the given Entity.
-	*/
-	propertyName: string;
-	/**
-	* The name of the function that will be used to calculate the value for the property.
-	*/
-	calculatedPropertyFunctionName: string;
-	/**
-	* Any decorators that should be applied to the calculated property.
-	* These will be added to the {@link C3Type} that is created for the Entity.
-	*/
-	decorators?: C3Decorator14[];
-}
-import { MultiTenancyType as MultiTenancyType2 } from "@kinotic-ai/persistence";
-import { PropertyDefinition } from "@kinotic-ai/idl";
-/**
-* The configuration for a property that should be overridden.
-* This allows you to specify a static {@link PropertyDefinition} for a property.
-*/
-declare class OverrideConfiguration {
-	/**
-	* The json path to the property that should be overridden.
-	*/
-	jsonPath: string;
-	/**
-	* The {@link PropertyDefinition} that should be used for the property.
-	*/
-	propertyDefinition: PropertyDefinition;
-}
-/**
-* The configuration for a function that will transform a value before it is sent to the server.
-* The function must be exported from a file that is specified in {@link TypescriptExternalProjectConfig.utilFunctionsPaths}
-* The function return argument will be the resulting {@link C3Type} that will be configured for the Entity
-*/
-declare class TransformConfiguration {
-	/**
-	* The json path to the property that should be transformed.
-	* There must only be one {@link TransformConfiguration} per jsonPath.
-	*/
-	jsonPath: string;
-	/**
-	* The name of the function that will be used to transform the value.
-	*/
-	transformerFunctionName: string;
-}
-/**
-* The configuration for an External Entity.
-* This allows you to specify an Entity that is part of an external codebase.
-*/
-declare class EntityConfiguration {
-	/**
-	* The name of the Entity that will be used to create the Structure.
-	*/
-	entityName: string;
-	/**
-	* The multi tenancy type for this Entity.
-	*/
-	multiTenancyType: MultiTenancyType2;
-	/**
-	* Json paths to properties that should be excluded from the Entity.
-	* These have a higher priority than {@link OverrideConfiguration} and {@link TransformConfiguration}
-	*/
-	excludeJsonPaths?: string[];
-	/**
-	* Array of {@link OverrideConfiguration} that should be applied to the Entity.
-	* These have a higher priority than {@link TransformConfiguration}s
-	*/
-	overrides?: OverrideConfiguration[];
-	/**
-	* Array of {@link TransformConfiguration} that should be applied to the Entity.
-	* These have a lower priority than {@link OverrideConfiguration}s.
-	*/
-	transforms?: TransformConfiguration[];
-	/**
-	* Array of {@link CalculatedPropertyConfiguration} that should be applied to the Entity.
-	* The calculated property function will be called for every instance of the Entity.
-	* And is passed the instance of the Entity as the first argument.
-	* And the json path as the second argument.
-	* These have the highest priority.
-	*/
-	calculatedProperties?: CalculatedPropertyConfiguration[];
-}
-/**
-* The project configuration for a structures project.
-* This is the base configuration. Language specific configurations extend this configuration.
-*/
-declare abstract class KinoticProjectConfig {
-	/**
-	* This specifies the Model Definition Language (MDL).
-	* This is the language that is used to define the structures models.
-	* The following values are supported:
-	* - ts: TypeScript
-	* - ts-external: TypeScript with external models (defined by an external package)
-	* - gql: GraphQL
-	*/
-	mdl: "ts" | "ts-external" | "gql";
-	/**
-	* The name of the project or undefined if a language specific 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 Structures Application that this project belongs to.
-	*/
-	application: string;
-	/**
-	* The paths to search for classes decorated with @Entity that Structures will be created for.
-	*/
-	entitiesPaths: string[];
-	/**
-	* The path to where generated files will be placed.
-	*/
-	generatedPath: string;
-	/**
-	* The file extension to use for imports in generated files.
-	*/
-	fileExtensionForImports: string;
-	/**
-	* If true the generated EntityService classes will validate all data before sending to the server.
-	*/
-	validate?: boolean;
-}
-/**
-* The project configuration for a TypeScript structures project.
-*/
-declare class TypescriptProjectConfig extends KinoticProjectConfig {
-	readonly mdl = "ts";
-}
-/**
-* The project configuration for a TypeScript structures project.
-*/
-declare class TypescriptExternalProjectConfig extends KinoticProjectConfig {
-	readonly mdl = "ts-external";
-	/**
-	* External EntityConfigurations that are part of an external codebase and that you cannot add @Entity decorators to.
-	*/
-	externalEntities?: {
-		[pathPattern: string]: EntityConfiguration[];
-	};
-	/**
-	* The path to look for files that functions that can be used by a {@link TransformConfiguration} or {@link CalculatedPropertyConfiguration}.
-	*/
-	utilFunctionsPaths?: string[];
-}
 /**
 * Represents an individual web component generated by the data insights system.
 * Each component is a self-contained visualization that can be dropped into any page.
@@ -791,4 +635,4 @@ import { Kinotic, KinoticSingleton as KinoticSingleton2, IKinotic as IKinotic8,
 declare module "@kinotic-ai/core" {
 	interface KinoticSingleton extends IOsApiExtension {}
 }
-export { VersionDecorator, TypescriptProjectConfig, TypescriptExternalProjectConfig, TransformConfiguration, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, RoleDecorator, QueryOptionsC3Type, QueryDecorator, ProjectType2 as ProjectType, ProjectService, Project, ProgressType, PolicyDecorator, PageableC3Type, PageC3Type, OverrideConfiguration, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticSingleton2 as KinoticSingleton, KinoticProjectConfig, KinoticPlugin2 as KinoticPlugin, Kinotic, InsightRequest, InsightProgress, IdDecorator, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IKinotic8 as IKinotic, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, EntityConfiguration, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, CalculatedPropertyConfiguration, AutoGeneratedIdDecorator, ApplicationService, Application, $Role, $Policy };
+export { VersionDecorator, TimeReferenceDecorator, TextDecorator, TenantSelectionC3Type, TenantIdDecorator, SingleLoggerLevelsDescriptor, RoleDecorator, QueryOptionsC3Type, QueryDecorator, ProjectType2 as ProjectType, ProjectService, Project, ProgressType, PolicyDecorator, PageableC3Type, PageC3Type, OsApiPlugin, NotIndexedDecorator, NestedDecorator, NamedQueriesDefinitionService, NamedQueriesDefinition, MigrationService, MigrationResult, MigrationRequest, MigrationDefinition, LoggersDescriptor, LoggerLevelsDescriptor, LogManager, LogLevel, KinoticSingleton2 as KinoticSingleton, KinoticPlugin2 as KinoticPlugin, Kinotic, InsightRequest, InsightProgress, IdDecorator, IProjectService, IOsApiExtension, INamedQueriesDefinitionService, IMigrationService, ILogManager, IKinotic8 as IKinotic, IEntityDefinitionService, IDataInsightsService, IApplicationService, GroupLoggerLevelsDescriptor, FlattenedDecorator, EsIndexConfigurationDecorator, EntityDefinitionService, EntityDefinition, EntityDecorator, DiscriminatorDecorator, DataInsightsService, DataInsightsComponent, AutoGeneratedIdDecorator, ApplicationService, Application, $Role, $Policy };

package/dist/index.js

@@ -271,53 +271,6 @@ class NamedQueriesDefinition {
     this.namedQueries = namedQueries;
   }
 }
-// packages/os-api/src/api/model/config/CalculatedPropertyConfiguration.ts
-class CalculatedPropertyConfiguration {
-  entityJsonPath;
-  propertyName;
-  calculatedPropertyFunctionName;
-  decorators;
-}
-// packages/os-api/src/api/model/config/EntityConfiguration.ts
-class EntityConfiguration {
-  entityName;
-  multiTenancyType;
-  excludeJsonPaths;
-  overrides;
-  transforms;
-  calculatedProperties;
-}
-// packages/os-api/src/api/model/config/OverrideConfiguration.ts
-class OverrideConfiguration {
-  jsonPath;
-  propertyDefinition;
-}
-// packages/os-api/src/api/model/config/KinoticProjectConfig.ts
-class KinoticProjectConfig {
-  mdl;
-  name;
-  description;
-  application;
-  entitiesPaths;
-  generatedPath;
-  fileExtensionForImports = ".js";
-  validate;
-}
-
-class TypescriptProjectConfig extends KinoticProjectConfig {
-  mdl = "ts";
-}
-
-class TypescriptExternalProjectConfig extends KinoticProjectConfig {
-  mdl = "ts-external";
-  externalEntities;
-  utilFunctionsPaths;
-}
-// packages/os-api/src/api/model/config/TransformConfiguration.ts
-class TransformConfiguration {
-  jsonPath;
-  transformerFunctionName;
-}
 // packages/os-api/src/api/model/insights/InsightProgress.ts
 var ProgressType;
 ((ProgressType2) => {
@@ -518,9 +471,6 @@ var OsApiPlugin = {
 import { Kinotic, KinoticSingleton } from "@kinotic-ai/core";
 export {
   VersionDecorator,
-  TypescriptProjectConfig,
-  TypescriptExternalProjectConfig,
-  TransformConfiguration,
   TimeReferenceDecorator,
   TextDecorator,
   TenantSelectionC3Type,
@@ -536,7 +486,6 @@ export {
   PolicyDecorator,
   PageableC3Type,
   PageC3Type,
-  OverrideConfiguration,
   OsApiPlugin,
   NotIndexedDecorator,
   NestedDecorator,
@@ -548,7 +497,6 @@ export {
   LogManager,
   LogLevel,
   KinoticSingleton,
-  KinoticProjectConfig,
   Kinotic,
   IdDecorator,
   GroupLoggerLevelsDescriptor,
@@ -557,10 +505,8 @@ export {
   EntityDefinitionService,
   EntityDefinition,
   EntityDecorator,
-  EntityConfiguration,
   DiscriminatorDecorator,
   DataInsightsService,
-  CalculatedPropertyConfiguration,
   AutoGeneratedIdDecorator,
   ApplicationService,
   Application,

package/package.json

@@ -51,5 +51,5 @@
       "optional": true
     }
   },
-  "version": "1.0.2"
+  "version": "1.0.3"
 }