@osdk/api 1.1.1 → 1.2.0

package/build/types/index.d.ts

@@ -1,7 +1,7 @@
 export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, } from "./ontology/ActionDefinition";
-export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, } from "./ontology/InterfaceDefinition";
-export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, } from "./ontology/ObjectOrInterface";
-export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ontology/ObjectTypeDefinition";
+export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, InterfacePropertyKeysFrom2, } from "./ontology/InterfaceDefinition";
+export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, ObjectOrInterfacePropertyKeysFrom2, } from "./ontology/ObjectOrInterface";
+export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkKeysFrom2, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionFrom2, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ontology/ObjectTypeDefinition";
 export type { OntologyDefinition } from "./ontology/OntologyDefinition";
 export type { AggregationKeyDataType, ObjectQueryDataType, ObjectSetQueryDataType, PrimitiveDataType, QueryDataTypeDefinition, QueryDefinition, QueryParameterDefinition, RangeAggregationKeyDataType, SetQueryDataType, SimpleAggregationKeyDataType, StructQueryDataType, ThreeDimensionalAggregationDataType, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalAggregationDataType, TwoDimensionalQueryAggregationDefinition, UnionQueryDataType, WireQueryDataTypes, } from "./ontology/QueryDefinition";
 export type { WirePropertyTypes } from "./ontology/WirePropertyTypes";

package/build/types/ontology/ActionDefinition.d.ts

@@ -1,8 +1,11 @@
-export interface ActionDefinition<A extends string, K extends string> {
+import type { ObjectTypeDefinition } from "..";
+export interface ActionDefinition<A extends string, K extends string, T = never> {
+    __OsdkActionType?: T;
+    type: "action";
     apiName: A;
     description?: string;
     displayName?: string;
-    parameters: Record<string, ActionParameterDefinition<K>>;
+    parameters: Record<any, ActionParameterDefinition<K, any>>;
     modifiedEntities?: Partial<Record<K, ActionModifiedEntity>>;
 }
 export interface ActionModifiedEntity {
@@ -18,18 +21,21 @@ export interface ValidBaseActionParameterTypes {
     datetime: Date;
     timestamp: Date;
     attachment: any;
+    marking: string;
 }
-export interface ObjectActionDataType<K extends string> {
+export interface ObjectActionDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> {
+    __OsdkTargetType?: T_Target;
     type: "object";
     object: K;
 }
-export interface ObjectSetActionDataType<K extends string> {
+export interface ObjectSetActionDataType<K extends string, T_Target extends ObjectTypeDefinition<any> = never> {
+    __OsdkTargetType?: T_Target;
     type: "objectSet";
     objectSet: K;
 }
-export type ValidActionParameterTypes<K extends string = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K> | ObjectSetActionDataType<K>;
-export interface ActionParameterDefinition<K extends string = never> {
-    type: ValidActionParameterTypes<K>;
+export type ValidActionParameterTypes<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> = keyof ValidBaseActionParameterTypes | ObjectActionDataType<K, T_Target> | ObjectSetActionDataType<K, T_Target>;
+export interface ActionParameterDefinition<K extends string = never, T_Target extends ObjectTypeDefinition<any> = never> {
+    type: ValidActionParameterTypes<K, T_Target>;
     description?: string;
     multiplicity?: boolean;
     nullable?: boolean;

package/build/types/ontology/InterfaceDefinition.d.ts

@@ -1,12 +1,15 @@
-import type { ObjectTypePropertyDefinition } from "./ObjectTypeDefinition";
+import type { ObjectTypeLinkDefinition, ObjectTypePropertyDefinition } from "./ObjectTypeDefinition";
 import type { OntologyDefinition } from "./OntologyDefinition";
 export type InterfaceDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = O["interfaces"] extends {} ? O["interfaces"][K] : never;
 export type InterfaceKeysFrom<O extends OntologyDefinition<string>> = keyof O["interfaces"];
 export type InterfacePropertyKeysFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = keyof InterfaceDefinitionFrom<O, K>["properties"] & string;
+export type InterfacePropertyKeysFrom2<I extends InterfaceDefinition<any, any>> = keyof I["properties"] & string;
 export type InterfacePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>> = InterfaceDefinitionFrom<O, K>["properties"];
 export type InterfacePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends InterfaceKeysFrom<O>, P extends InterfacePropertyKeysFrom<O, K>> = InterfacePropertyDefinitionsFrom<O, K>[P];
 export interface InterfaceDefinition<K extends string, _L extends string> {
+    type: "interface";
     apiName: K;
     description?: string;
     properties: Record<string, ObjectTypePropertyDefinition>;
+    links: Record<string, ObjectTypeLinkDefinition<any, any>>;
 }

package/build/types/ontology/ObjectOrInterface.d.ts

@@ -2,6 +2,7 @@ import type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, I
 import type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypePropertyKeysFrom } from "./ObjectTypeDefinition";
 import type { OntologyDefinition } from "./OntologyDefinition";
 export type ObjectOrInterfaceKeysFrom<O extends OntologyDefinition<any, any>> = ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>;
-export type ObjectOrInterfaceDefinition<K extends string, L extends string> = ObjectTypeDefinition<K, L> | InterfaceDefinition<K, L>;
+export type ObjectOrInterfaceDefinition<K extends string = any, L extends string = any> = ObjectTypeDefinition<K> | InterfaceDefinition<K, L>;
 export type ObjectOrInterfacePropertyKeysFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfacePropertyKeysFrom<O, K> : ObjectTypePropertyKeysFrom<O, K>;
+export type ObjectOrInterfacePropertyKeysFrom2<O extends ObjectTypeDefinition<any> | InterfaceDefinition<any, any>> = keyof O["properties"] & string;
 export type ObjectOrInterfaceDefinitionFrom<O extends OntologyDefinition<any, any>, K extends ObjectOrInterfaceKeysFrom<O>> = K extends InterfaceKeysFrom<O> ? InterfaceDefinitionFrom<O, K> : ObjectTypeDefinitionFrom<O, K>;

package/build/types/ontology/ObjectTypeDefinition.d.ts

@@ -1,3 +1,4 @@
+import type { ObjectOrInterfaceDefinition } from "..";
 import type { OntologyDefinition } from "./OntologyDefinition";
 import type { WirePropertyTypes } from "./WirePropertyTypes";
 export type ObjectTypeDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = O["objects"][K];
@@ -5,17 +6,21 @@ export type ObjectTypeKeysFrom<O extends OntologyDefinition<string>> = keyof O["
 export type ObjectTypePropertyKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["properties"] & string;
 export type ObjectTypePropertyDefinitionsFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = ObjectTypeDefinitionFrom<O, K>["properties"];
 export type ObjectTypePropertyDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, P extends ObjectTypePropertyKeysFrom<O, K>> = ObjectTypePropertyDefinitionsFrom<O, K>[P];
-export interface ObjectTypeDefinition<K extends string, L extends string> {
+export type ObjectTypePropertyDefinitionFrom2<Q extends ObjectOrInterfaceDefinition<any, any>, P extends keyof Q["properties"] & string> = Q["properties"][P];
+export interface ObjectTypeDefinition<K extends string> {
+    type: "object";
     apiName: K;
     description?: string;
     primaryKeyType: keyof WirePropertyTypes;
     properties: Record<string, ObjectTypePropertyDefinition>;
-    links: Record<string, ObjectTypeLinkDefinition<L>>;
+    links: Record<string, ObjectTypeLinkDefinition<any, any>>;
 }
 export type ObjectTypeLinkKeysFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = keyof ObjectTypeDefinitionFrom<O, K>["links"];
-export interface ObjectTypeLinkDefinition<K extends string> {
-    targetType: K;
-    multiplicity: boolean;
+export type ObjectTypeLinkKeysFrom2<O extends ObjectTypeDefinition<any>> = keyof O["links"] & string;
+export interface ObjectTypeLinkDefinition<O extends ObjectTypeDefinition<any>, M extends boolean> {
+    __Mark?: O;
+    targetType: O["apiName"];
+    multiplicity: M;
 }
 export type ObjectTypeLinkDefinitionFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeDefinitionFrom<O, K>["links"][L];
 export type ObjectTypeLinkTargetTypeFrom<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypeLinkKeysFrom<O, K>> = ObjectTypeLinkDefinitionFrom<O, K, L>["targetType"];

package/build/types/ontology/OntologyDefinition.d.ts

@@ -6,10 +6,10 @@ import type { QueryDefinition } from "./QueryDefinition";
 export interface OntologyDefinition<K extends string, A extends string = any, Q extends string = any, I extends string = any> {
     metadata: OntologyMetadata;
     objects: {
-        [KK in K]: ObjectTypeDefinition<KK, K>;
+        [KK in K]: ObjectTypeDefinition<KK>;
     };
     actions: {
-        [AA in A]: ActionDefinition<AA, K>;
+        [AA in A]: ActionDefinition<AA, K, any>;
     };
     queries: {
         [QQ in Q]: QueryDefinition<QQ, K>;

package/build/types/ontology/QueryDefinition.d.ts

@@ -1,4 +1,5 @@
 export interface QueryDefinition<Q extends string, K extends string> {
+    type: "query";
     apiName: Q;
     description?: string;
     displayName?: string;

package/build/types/ontology/WirePropertyTypes.d.ts

@@ -11,6 +11,7 @@ export interface WirePropertyTypes {
     float: number;
     decimal: number;
     byte: number;
+    marking: string;
     numericTimeseries: any;
     stringTimeseries: any;
     attachment: any;

package/build/types/ontology/index.d.ts

@@ -1,5 +1,5 @@
 export type { ActionDefinition, ActionModifiedEntity, ActionParameterDefinition, ObjectActionDataType, ObjectSetActionDataType, ValidActionParameterTypes, ValidBaseActionParameterTypes, } from "./ActionDefinition";
-export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, } from "./InterfaceDefinition";
+export type { InterfaceDefinition, InterfaceDefinitionFrom, InterfaceKeysFrom, InterfacePropertyDefinitionFrom, InterfacePropertyDefinitionsFrom, InterfacePropertyKeysFrom, InterfacePropertyKeysFrom2, } from "./InterfaceDefinition";
 export type { ObjectOrInterfaceDefinition, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, } from "./ObjectOrInterface";
 export type { ObjectTypeDefinition, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom as ObjectTypeKeysFrom, ObjectTypeLinkDefinition, ObjectTypeLinkDefinitionFrom, ObjectTypeLinkKeysFrom, ObjectTypeLinkTargetTypeFrom, ObjectTypePropertyDefinition, ObjectTypePropertyDefinitionFrom, ObjectTypePropertyDefinitionsFrom, ObjectTypePropertyKeysFrom, } from "./ObjectTypeDefinition";
 export type { OntologyDefinition } from "./OntologyDefinition";

package/changelog/1.2.0/pr-48.v2.yml

@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Prep for new client syntax
+  links:
+  - https://github.com/palantir/osdk-ts/pull/48

package/changelog/1.2.0/pr-65.v2.yml

@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Prep for actions
+  links:
+  - https://github.com/palantir/osdk-ts/pull/65

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@osdk/api",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
   "exports": {
     ".": {
       "types": "./build/types/index.d.ts",
@@ -20,8 +24,8 @@
     "@types/geojson": "^7946.0.13",
     "fetch-retry": "^5.0.6",
     "tiny-invariant": "^1.3.1",
-    "@osdk/gateway": "1.1.1",
-    "@osdk/shared.net": "1.1.1"
+    "@osdk/gateway": "1.2.0",
+    "@osdk/shared.net": "1.3.0"
   },
   "devDependencies": {
     "ts-expect": "^1.3.0",
@@ -34,8 +38,10 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
+    "templates",
     "*.d.ts"
   ],
   "main": "./build/js/index.js",