@nyrra/maker 0.0.1

package/README.md

@@ -0,0 +1,11 @@
+# @nyrra/maker
+
+Maker-compatible ontology-as-code primitives used by Prismantix packages.
+
+## Build
+
+Run `pnpm exec nx build maker --skip-nx-cache`.
+
+## Test
+
+Run `pnpm exec nx test maker --skip-nx-cache`.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/ontology-maker.js";

package/dist/index.js

@@ -0,0 +1 @@
+export * from "./lib/ontology-maker.js";

package/dist/lib/ontology-maker.d.ts

@@ -0,0 +1,119 @@
+export declare const UPSTREAM_MAKER_PACKAGE = "@osdk/maker";
+export declare const UPSTREAM_MAKER_VERSION = "0.16.0-beta.7";
+export type TableName = `datastudio_${string}`;
+export type TableCategory = "master-data" | "quality-events" | "analytics" | "system";
+export type TableDomain = "masterData" | "pharmaQualityOps" | "analytics" | "application" | "accessControl";
+export type ExampleValue = boolean | null | number | string | readonly ExampleValue[];
+export type PrimitiveTypeName = "boolean" | "double" | "integer" | "string" | "timestamp";
+export interface PrimitiveValueTypeDefinition {
+    readonly type: PrimitiveTypeName;
+}
+export interface EnumValueTypeDefinition {
+    readonly type: "enum";
+    readonly values: readonly [string, ...string[]];
+}
+export type ValueTypeDefinitionInput = EnumValueTypeDefinition | PrimitiveValueTypeDefinition;
+export interface PrismantixValueTypeDefinition {
+    readonly apiName: string;
+    readonly description?: string;
+    readonly displayName: string;
+    readonly entityType: "valueType";
+    readonly exampleValues?: readonly ExampleValue[];
+    readonly type: ValueTypeDefinitionInput;
+}
+export interface ExternalObjectDefinition {
+    readonly apiName: string;
+    readonly description?: string;
+    readonly displayName: string;
+    readonly entityType: "externalObject";
+    readonly pluralDisplayName: string;
+    readonly tableName: TableName;
+}
+export type ReferenceTarget = ExternalObjectDefinition | PrismantixObjectDefinition | string;
+export interface PrismantixObjectPropertyDefinition {
+    readonly array?: boolean;
+    readonly description?: string;
+    readonly displayName: string;
+    readonly exampleValues?: readonly ExampleValue[];
+    readonly nullable?: boolean;
+    readonly optional?: boolean;
+    readonly reference?: ReferenceTarget;
+    readonly type: PrimitiveTypeName | PrismantixValueTypeDefinition;
+}
+export interface OntologyIndexDefinition {
+    readonly fields: readonly [string, ...string[]];
+    readonly name: string;
+}
+export interface PrismantixObjectMetadata {
+    readonly category: TableCategory;
+    readonly convex: {
+        readonly componentName: "ontology";
+        readonly indexes: readonly OntologyIndexDefinition[];
+        readonly materialized: boolean;
+        readonly tableName: TableName;
+    };
+    readonly defaults?: {
+        readonly fabricationCount?: number;
+        readonly seedCount?: number;
+    };
+    readonly domain: TableDomain;
+    readonly guidance?: readonly string[];
+    readonly notes?: string;
+    readonly requiresClient: boolean;
+    readonly seeding?: {
+        readonly order?: number;
+        readonly requires?: readonly TableName[];
+        readonly skipReason?: string;
+    };
+    readonly showInNavigation: boolean;
+}
+export interface PrismantixObjectDefinition {
+    readonly aliases?: readonly string[];
+    readonly apiName: string;
+    readonly description?: string;
+    readonly displayName: string;
+    readonly editsEnabled?: boolean;
+    readonly entityType: "object";
+    readonly pluralDisplayName: string;
+    readonly primaryKeyPropertyApiName: string;
+    readonly prismantix: PrismantixObjectMetadata;
+    readonly properties: Readonly<Record<string, PrismantixObjectPropertyDefinition>>;
+    readonly titlePropertyApiName: string;
+}
+export interface LinkSideDefinition {
+    readonly apiName: string;
+    readonly description?: string;
+    readonly displayName: string;
+    readonly object: ReferenceTarget;
+    readonly pluralDisplayName: string;
+}
+export interface OneToManyLinkDefinition {
+    readonly apiName: string;
+    readonly cardinality?: "OneToMany" | "OneToOne";
+    readonly description?: string;
+    readonly entityType: "link";
+    readonly manyForeignKeyProperty: string;
+    readonly one: LinkSideDefinition;
+    readonly toMany: LinkSideDefinition;
+}
+export interface ManyToManyLinkDefinition {
+    readonly apiName: string;
+    readonly description?: string;
+    readonly entityType: "link";
+    readonly many: LinkSideDefinition;
+    readonly manyForeignKeyProperty?: string;
+    readonly toMany: LinkSideDefinition;
+    readonly toManyForeignKeyProperty?: string;
+}
+export type PrismantixLinkDefinition = ManyToManyLinkDefinition | OneToManyLinkDefinition;
+export declare function defineValueType(valueType: Omit<PrismantixValueTypeDefinition, "entityType">): PrismantixValueTypeDefinition;
+export declare function defineExternalObject(object: Omit<ExternalObjectDefinition, "entityType">): ExternalObjectDefinition;
+export declare function defineObject(object: Omit<PrismantixObjectDefinition, "entityType">): PrismantixObjectDefinition;
+export declare function defineLink(link: Omit<OneToManyLinkDefinition, "entityType">): OneToManyLinkDefinition;
+export declare function defineLink(link: Omit<ManyToManyLinkDefinition, "entityType">): ManyToManyLinkDefinition;
+export declare function uppercaseFirstLetter(value: string | null | undefined): string;
+export declare function convertToDisplayName(value: string | null | undefined): string;
+export declare function convertToPluralDisplayName(value: string | null | undefined): string;
+export declare function isEnumValueType(valueType: PrismantixValueTypeDefinition): valueType is PrismantixValueTypeDefinition & {
+    readonly type: EnumValueTypeDefinition;
+};

package/dist/lib/ontology-maker.js

@@ -0,0 +1,60 @@
+export const UPSTREAM_MAKER_PACKAGE = "@osdk/maker";
+export const UPSTREAM_MAKER_VERSION = "0.16.0-beta.7";
+export function defineValueType(valueType) {
+    return {
+        ...valueType,
+        entityType: "valueType",
+    };
+}
+export function defineExternalObject(object) {
+    return {
+        ...object,
+        entityType: "externalObject",
+    };
+}
+export function defineObject(object) {
+    return {
+        ...object,
+        entityType: "object",
+    };
+}
+export function defineLink(link) {
+    return {
+        ...link,
+        entityType: "link",
+    };
+}
+export function uppercaseFirstLetter(value) {
+    if (!value) {
+        return "";
+    }
+    return value.charAt(0).toUpperCase() + value.slice(1);
+}
+export function convertToDisplayName(value) {
+    if (!value) {
+        return "";
+    }
+    return value
+        .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
+        .replace(/[_-]+/g, " ")
+        .split(" ")
+        .filter(Boolean)
+        .map((part) => uppercaseFirstLetter(part))
+        .join(" ");
+}
+export function convertToPluralDisplayName(value) {
+    const displayName = convertToDisplayName(value);
+    if (!displayName) {
+        return "";
+    }
+    if (displayName.endsWith("s")) {
+        return displayName;
+    }
+    if (displayName.endsWith("y")) {
+        return `${displayName.slice(0, -1)}ies`;
+    }
+    return `${displayName}s`;
+}
+export function isEnumValueType(valueType) {
+    return valueType.type.type === "enum";
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@nyrra/maker",
+	"version": "0.0.1",
+	"description": "Nyrra-maintained Maker fork for ontology-as-code definitions.",
+	"license": "MIT",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/nyrra-labs/prismantix.git"
+	},
+	"homepage": "https://github.com/nyrra-labs/prismantix#readme",
+	"bugs": {
+		"url": "https://github.com/nyrra-labs/prismantix/issues"
+	},
+	"keywords": [
+		"maker",
+		"ontology",
+		"ontology-as-code",
+		"palantir",
+		"osdk"
+	],
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"@prismantix/source": "./src/index.ts",
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		}
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.map",
+		"!**/*.tsbuildinfo"
+	],
+	"nx": {
+		"name": "maker"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"dependencies": {
+		"tslib": "^2.3.0"
+	}
+}