@osdk/api 2.2.0-beta.2 → 2.2.0-beta.21

package/build/types/public/unstable.d.ts

@@ -1,6 +1,7 @@
-export type  { Experiment, ExperimentFns } from "../experimental/Experiment.js";
+export type { Experiment, ExperimentFns } from "../experimental/Experiment.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference } from "../experimental/createMediaReference.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid } from "../experimental/fetchOneByRid.js";
+export { __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid } from "../experimental/fetchPageByRid.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks } from "../experimental/getBulkLinks.js";
-export type  { EXPERIMENTAL_BulkLinkResult } from "../objectSet/BulkLinkResult.js";
-export type  { MinimalObjectSet } from "../objectSet/ObjectSet.js";
+export type { EXPERIMENTAL_BulkLinkResult } from "../objectSet/BulkLinkResult.js";
+export type { MinimalObjectSet } from "../objectSet/ObjectSet.js";

package/build/types/public/unstable.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,eAAc,YAAY,qBAAqB;AAE/C,SAAS,+DAA+D;AACxE,SAAS,wDAAwD;AACjE,SAAS,uDAAuD;AAEhE,eAAc,mCAAmC;AACjD,eAAc,wBAAwB","names":[],"sources":["../../../src/public/unstable.ts"],"version":3,"file":"unstable.d.ts"}
+{"mappings":"AAgBA,cAAc,YAAY,qBAAqB;AAE/C,SAAS,+DAA+D;AACxE,SAAS,wDAAwD;AACjE,SAAS,yDAAyD;AAClE,SAAS,uDAAuD;AAEhE,cAAc,mCAAmC;AACjD,cAAc,wBAAwB","names":[],"sources":["../../../src/public/unstable.ts"],"version":3,"file":"unstable.d.ts"}

package/build/types/queries/Queries.d.ts

@@ -2,7 +2,7 @@ import type { DataValueClientToWire, DataValueWireToClient } from "../mapping/Da
 import type { ObjectSet } from "../objectSet/ObjectSet.js";
 import type { ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
 import type { AggregationKeyTypes, AggregationRangeKeyTypes, AggregationValueTypes } from "../ontology/QueryDefinition.js";
-import type { OsdkBase } from "../OsdkBase.js";
+import type { OsdkBase, OsdkBaseWithObjectSpecifier } from "../OsdkBase.js";
 import type { OsdkObjectPrimaryKeyType } from "../OsdkObjectPrimaryKeyType.js";
 import type { AggKeyClientToWire, AggKeyWireToClient, AggValueClientToWire, AggValueWireToClient, ThreeDimensionalAggregation, TwoDimensionalAggregation } from "./Aggregations.js";
 /**
@@ -28,7 +28,7 @@ export declare namespace QueryParam {
 */
 export declare namespace QueryResult {
 	type PrimitiveType<T extends keyof DataValueClientToWire> = DataValueWireToClient[T];
-	type ObjectType<T extends ObjectTypeDefinition> = OsdkBase<T>;
+	type ObjectType<T extends ObjectTypeDefinition> = OsdkBaseWithObjectSpecifier<T>;
 	type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;
 	type RangeKey<T extends AggregationRangeKeyTypes> = AggKeyWireToClient<"range", T>;
 	type TwoDimensionalAggregationType<

package/build/types/queries/Queries.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,uBACA,6BACK,gCAAiC;AACxC,cAAc,iBAAiB,2BAA4B;AAC3D,cAAc,4BAA4B,qCAAsC;AAChF,cACE,qBACA,0BACA,6BACK,gCAAiC;AACxC,cAAc,gBAAgB,gBAAiB;AAC/C,cAAc,gCAAgC,gCAAiC;AAC/E,cACE,oBACA,oBACA,sBACA,sBACA,6BACA,iCACK,mBAAoB;;;;AAK3B,yBAAiB;MAIH,cAAc,gBAAgB,yBACxC,sBAAsB;MAKZ,WAAW,UAAU,wBAC7B,SAAS,KACT,yBAAyB;MAKjB,cAAc,UAAU,wBAAwB,UAAU;MAE1D,SAAS,UAAU,4BAA4B,mBACzD,SACA;MAGU;EACV,UAAU,sBAAsB;EAChC,UAAU;KACR,0BACF,UAAU,sBAAsB,mBAAmB,KAAK,GACxD,qBAAqB;MAGX;EACV,YAAY,sBAAsB;EAClC,WAAW,sBAAsB;EACjC,UAAU;KACR,4BACF,YAAY,sBAAsB,mBAAmB,OAAO,KAC5D,WAAW,sBAAsB,mBAAmB,MAAM,IAC1D,qBAAqB;;;;;AAOzB,yBAAiB;MAIH,cAAc,gBAAgB,yBACxC,sBAAsB;MAKZ,WAAW,UAAU,wBAAwB,SAAS;MAKtD,cAAc,UAAU,wBAAwB,UAC1D;MAGU,SAAS,UAAU,4BAA4B,mBACzD,SACA;MAGU;EACV,UAAU,sBAAsB;EAChC,UAAU;KACR,0BACF,UAAU,sBAAsB,mBAAmB,KAAK,GACxD,qBAAqB;MAGX;EACV,YAAY,sBAAsB;EAClC,WAAW,sBAAsB;EACjC,UAAU;KACR,4BACF,YAAY,sBAAsB,mBAAmB,OAAO,KAC5D,WAAW,sBAAsB,mBAAmB,MAAM,IAC1D,qBAAqB","names":[],"sources":["../../../src/queries/Queries.ts"],"version":3,"file":"Queries.d.ts"}
+{"mappings":"AAgBA,cACE,uBACA,6BACK,gCAAiC;AACxC,cAAc,iBAAiB,2BAA4B;AAC3D,cAAc,4BAA4B,qCAAsC;AAChF,cACE,qBACA,0BACA,6BACK,gCAAiC;AACxC,cAAc,UAAU,mCAAmC,gBAAiB;AAC5E,cAAc,gCAAgC,gCAAiC;AAC/E,cACE,oBACA,oBACA,sBACA,sBACA,6BACA,iCACK,mBAAoB;;;;AAK3B,yBAAiB;MAIH,cAAc,gBAAgB,yBACxC,sBAAsB;MAKZ,WAAW,UAAU,wBAC7B,SAAS,KACT,yBAAyB;MAKjB,cAAc,UAAU,wBAAwB,UAAU;MAE1D,SAAS,UAAU,4BAA4B,mBACzD,SACA;MAGU;EACV,UAAU,sBAAsB;EAChC,UAAU;KACR,0BACF,UAAU,sBAAsB,mBAAmB,KAAK,GACxD,qBAAqB;MAGX;EACV,YAAY,sBAAsB;EAClC,WAAW,sBAAsB;EACjC,UAAU;KACR,4BACF,YAAY,sBAAsB,mBAAmB,OAAO,KAC5D,WAAW,sBAAsB,mBAAmB,MAAM,IAC1D,qBAAqB;;;;;AAOzB,yBAAiB;MAIH,cAAc,gBAAgB,yBACxC,sBAAsB;MAKZ,WAAW,UAAU,wBAC/B,4BAA4B;MAKlB,cAAc,UAAU,wBAAwB,UAC1D;MAGU,SAAS,UAAU,4BAA4B,mBACzD,SACA;MAGU;EACV,UAAU,sBAAsB;EAChC,UAAU;KACR,0BACF,UAAU,sBAAsB,mBAAmB,KAAK,GACxD,qBAAqB;MAGX;EACV,YAAY,sBAAsB;EAClC,WAAW,sBAAsB;EACjC,UAAU;KACR,4BACF,YAAY,sBAAsB,mBAAmB,OAAO,KAC5D,WAAW,sBAAsB,mBAAmB,MAAM,IAC1D,qBAAqB","names":[],"sources":["../../../src/queries/Queries.ts"],"version":3,"file":"Queries.d.ts"}

package/build/types/test/EmployeeApiTest.d.ts

@@ -0,0 +1,86 @@
+import type { ObjectMetadata as $ObjectMetadata, ObjectSet as $ObjectSet, ObjectTypeDefinition as $ObjectTypeDefinition, PropertyDef as $PropertyDef, PropertyValueWireToClient as $PropType, SingleLinkAccessor as $SingleLinkAccessor } from "../index.js";
+export declare namespace EmployeeApiTest {
+	type PropertyKeys = "employeeId" | "fullName" | "class" | "attachment" | "geopoint" | "timeseries" | "mediaReference" | "geotimeSeriesReference" | "isActive" | "yearsOfExperience" | "rank" | "performanceScore" | "hourlyRate" | "dateOfJoining" | "lastUpdated";
+	interface Links {
+		readonly lead: $SingleLinkAccessor<EmployeeApiTest>;
+		readonly peeps: EmployeeApiTest.ObjectSet;
+	}
+	interface Props {
+		readonly class: $PropType["string"] | undefined;
+		readonly fullName: $PropType["string"] | undefined;
+		readonly employeeId: $PropType["integer"] | undefined;
+		readonly attachment: $PropType["attachment"] | undefined;
+		readonly geopoint: $PropType["geopoint"] | undefined;
+		readonly timeseries: $PropType["numericTimeseries"] | undefined;
+		readonly mediaReference: $PropType["mediaReference"] | undefined;
+		readonly geotimeSeriesReference: $PropType["geotimeSeriesReference"] | undefined;
+		readonly isActive: $PropType["boolean"] | undefined;
+		readonly yearsOfExperience: $PropType["long"] | undefined;
+		readonly rank: $PropType["short"] | undefined;
+		readonly performanceScore: $PropType["double"] | undefined;
+		readonly hourlyRate: $PropType["float"] | undefined;
+		readonly dateOfJoining: $PropType["datetime"] | undefined;
+		readonly lastUpdated: $PropType["timestamp"] | undefined;
+	}
+	type StrictProps = Props;
+	interface ObjectSet extends $ObjectSet<EmployeeApiTest, EmployeeApiTest.ObjectSet> {}
+}
+export interface EmployeeApiTest extends $ObjectTypeDefinition {
+	type: "object";
+	apiName: "Employee";
+	__DefinitionMetadata?: {
+		objectSet: EmployeeApiTest.ObjectSet
+		props: EmployeeApiTest.Props
+		linksType: EmployeeApiTest.Links
+		strictProps: EmployeeApiTest.StrictProps
+		apiName: "Employee"
+		description: "A full-time or part-time \n\n employee of our firm"
+		displayName: "Employee"
+		icon: {
+			type: "blueprint"
+			color: "blue"
+			name: "person"
+		}
+		implements: ["FooInterface"]
+		interfaceMap: {
+			FooInterface: {
+				fooSpt: "fullName"
+			}
+		}
+		inverseInterfaceMap: {
+			FooInterface: {
+				fullName: "fooSpt"
+			}
+		}
+		links: {
+			lead: $ObjectMetadata.Link<EmployeeApiTest, false>
+			peeps: $ObjectMetadata.Link<EmployeeApiTest, true>
+		}
+		pluralDisplayName: "Employees"
+		primaryKeyApiName: "employeeId"
+		primaryKeyType: "integer"
+		properties: {
+			class: $PropertyDef<"string", "nullable", "single">
+			fullName: $PropertyDef<"string", "nullable", "single">
+			employeeId: $PropertyDef<"integer", "nullable", "single">
+			attachment: $PropertyDef<"attachment", "nullable", "single">
+			geopoint: $PropertyDef<"geopoint", "nullable", "single">
+			timeseries: $PropertyDef<"numericTimeseries", "nullable", "single">
+			mediaReference: $PropertyDef<"mediaReference", "nullable", "single">
+			geotimeSeriesReference: $PropertyDef<"geotimeSeriesReference", "nullable", "single">
+			isActive: $PropertyDef<"boolean", "nullable", "single">
+			yearsOfExperience: $PropertyDef<"long", "nullable", "single">
+			rank: $PropertyDef<"short", "nullable", "single">
+			performanceScore: $PropertyDef<"double", "nullable", "single">
+			hourlyRate: $PropertyDef<"float", "nullable", "single">
+			dateOfJoining: $PropertyDef<"datetime", "nullable", "single">
+			lastUpdated: $PropertyDef<"timestamp", "nullable", "single">
+		}
+		rid: "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"
+		status: "ACTIVE"
+		titleProperty: "fullName"
+		type: "object"
+		visibility: "NORMAL"
+	};
+}
+export declare const EmployeeApiTest: EmployeeApiTest;

package/build/types/test/EmployeeApiTest.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,kBAAkB,iBAClB,aAAa,YACb,wBAAwB,uBACxB,eAAe,cACf,6BAA6B,WAC7B,sBAAsB,2BACjB,aAAc;AAErB,yBAAiB;MACH,eACR,eACA,aACA,UACA,eACA,aACA,eACA,mBACA,2BACA,aACA,sBACA,SACA,qBACA,eACA,kBACA;WAEa,MAAM;WACZ,MAAM,oBAAoB;WAC1B,OAAO,gBAAgB;CACjC;WAEgB,MAAM;WACZ,OAAO,UAAU;WACjB,UAAU,UAAU;WACpB,YAAY,UAAU;WACtB,YAAY,UAAU;WACtB,UAAU,UAAU;WACpB,YAAY,UAAU;WACtB,gBAAgB,UAAU;WAC1B,wBACL,UAAU;WAEL,UAAU,UAAU;WACpB,mBAAmB,UAAU;WAC7B,MAAM,UAAU;WAChB,kBAAkB,UAAU;WAC5B,YAAY,UAAU;WACtB,eAAe,UAAU;WACzB,aAAa,UAAU;CACjC;MACW,cAAc;WAET,kBACP,WAAW,iBAAiB,gBAAgB,WACtD,CAAE;;AAGJ,iBAAiB,wBAAwB,sBAAsB;CAC7D,MAAM;CACN,SAAS;CACT,uBAAuB;EACrB,WAAW,gBAAgB;EAC3B,OAAO,gBAAgB;EACvB,WAAW,gBAAgB;EAC3B,aAAa,gBAAgB;EAC7B,SAAS;EACT,aAAa;EACb,aAAa;EACb,MAAM;GACJ,MAAM;GACN,OAAO;GACP,MAAM;EACP;EACD,aAAa;EACb,cAAc;GACZ,cAAc;IACZ,QAAQ;GACT;EACF;EACD,qBAAqB;GACnB,cAAc;IACZ,UAAU;GACX;EACF;EACD,OAAO;GACL,MAAM,gBAAgB,KAAK,iBAAiB;GAC5C,OAAO,gBAAgB,KAAK,iBAAiB;EAC9C;EACD,mBAAmB;EACnB,mBAAmB;EACnB,gBAAgB;EAChB,YAAY;GACV,OAAO,aAAa,UAAU,YAAY;GAC1C,UAAU,aAAa,UAAU,YAAY;GAC7C,YAAY,aAAa,WAAW,YAAY;GAChD,YAAY,aAAa,cAAc,YAAY;GACnD,UAAU,aAAa,YAAY,YAAY;GAC/C,YAAY,aAAa,qBAAqB,YAAY;GAC1D,gBAAgB,aAAa,kBAAkB,YAAY;GAC3D,wBAAwB,aACtB,0BACA,YACA;GAEF,UAAU,aAAa,WAAW,YAAY;GAC9C,mBAAmB,aAAa,QAAQ,YAAY;GACpD,MAAM,aAAa,SAAS,YAAY;GACxC,kBAAkB,aAAa,UAAU,YAAY;GACrD,YAAY,aAAa,SAAS,YAAY;GAC9C,eAAe,aAAa,YAAY,YAAY;GACpD,aAAa,aAAa,aAAa,YAAY;EACpD;EACD,KAAK;EACL,QAAQ;EACR,eAAe;EACf,MAAM;EACN,YAAY;CACb;AACF;AAED,OAAO,cAAMA,iBAAiB","names":["EmployeeApiTest: EmployeeApiTest"],"sources":["../../../src/test/EmployeeApiTest.ts"],"version":3,"file":"EmployeeApiTest.d.ts"}

package/build/types/test/FooInterfaceApiTest.d.ts

@@ -0,0 +1,50 @@
+import type { InterfaceDefinition as $InterfaceDefinition, ObjectSet as $ObjectSet, Osdk as $Osdk, PropertyDef as $PropertyDef, PropertyValueWireToClient as $PropType } from "../index.js";
+export type OsdkObjectLinks$FooInterface = {};
+export declare namespace FooInterfaceApiTest {
+	type PropertyKeys = "name" | "description";
+	interface Props {
+		readonly description: $PropType["string"] | undefined;
+		readonly name: $PropType["string"] | undefined;
+	}
+	type StrictProps = Props;
+	interface ObjectSet extends $ObjectSet<FooInterfaceApiTest, FooInterfaceApiTest.ObjectSet> {}
+	type OsdkInstance<
+		OPTIONS extends never | "$rid" = never,
+		K extends keyof FooInterfaceApiTest.Props = keyof FooInterfaceApiTest.Props
+	> = $Osdk.Instance<FooInterfaceApiTest, OPTIONS, K>;
+	type OsdkObject<
+		OPTIONS extends never | "$rid" = never,
+		K extends keyof FooInterfaceApiTest.Props = keyof FooInterfaceApiTest.Props
+	> = OsdkInstance<OPTIONS, K>;
+}
+export interface FooInterfaceApiTest extends $InterfaceDefinition {
+	osdkMetadata: any;
+	type: "interface";
+	apiName: "FooInterface";
+	__DefinitionMetadata?: {
+		objectSet: FooInterfaceApiTest.ObjectSet
+		props: FooInterfaceApiTest.Props
+		linksType: OsdkObjectLinks$FooInterface
+		strictProps: FooInterfaceApiTest.StrictProps
+		apiName: "FooInterface"
+		description: "Its a Foo."
+		displayName: "Foo interface"
+		links: {}
+		properties: {
+			/**
+			*   display name: 'Description',
+			*   description: Description of Description
+			*/
+			description: $PropertyDef<"string", "nullable", "single">
+			/**
+			*   display name: 'Name',
+			*   description: Name of Foo
+			*/
+			name: $PropertyDef<"string", "nullable", "single">
+		}
+		rid: "ri.ontology.main.interface-type.1b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b"
+		type: "interface"
+		implementedBy: ["Employee"]
+	};
+}
+export declare const FooInterfaceApiTest: FooInterfaceApiTest;

package/build/types/test/FooInterfaceApiTest.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,uBAAuB,sBACvB,aAAa,YACb,QAAQ,OACR,eAAe,cACf,6BAA6B,iBACxB,aAAc;AAErB,YAAY,+BAA+B,CAAE;AAE7C,yBAAiB;MACH,eAAe,SAAS;WAEnB,MAAM;WACZ,aAAa,UAAU;WACvB,MAAM,UAAU;CAC1B;MACW,cAAc;WAET,kBACP,WAAW,qBAAqB,oBAAoB,WAC9D,CAAE;MAEU;EACV,wBAAwB;EACxB,gBAAgB,oBAAoB,cAAc,oBAAoB;KACpE,MAAM,SAAS,qBAAqB,SAAS;MAGrC;EACV,wBAAwB;EACxB,gBAAgB,oBAAoB,cAAc,oBAAoB;KACpE,aAAa,SAAS;;AAG5B,iBAAiB,4BAA4B,qBAAqB;CAChE;CACA,MAAM;CACN,SAAS;CACT,uBAAuB;EACrB,WAAW,oBAAoB;EAC/B,OAAO,oBAAoB;EAC3B,WAAW;EACX,aAAa,oBAAoB;EACjC,SAAS;EACT,aAAa;EACb,aAAa;EACb,OAAO,CAAE;EACT,YAAY;;;;;GAKV,aAAa,aAAa,UAAU,YAAY;;;;;GAKhD,MAAM,aAAa,UAAU,YAAY;EAC1C;EACD,KAAK;EACL,MAAM;EACN,gBAAgB;CACjB;AACF;AAED,OAAO,cAAMA,qBAAqB","names":["FooInterfaceApiTest: FooInterfaceApiTest"],"sources":["../../../src/test/FooInterfaceApiTest.ts"],"version":3,"file":"FooInterfaceApiTest.d.ts"}

package/build/types/util/IncludeValuesExtending.d.ts

@@ -0,0 +1,4 @@
+export type IncludeValuesExtending<
+	T extends Record<keyof any, any>,
+	M
+> = { [K in keyof T as T[K] extends M ? K : never] : T[K] };

package/build/types/util/IncludeValuesExtending.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,YAAY;CAAuB,UAAU;CAAwB;OAClE,WAAW,KAAK,EAAE,WAAW,IAAI,aAAY,EAAE","names":[],"sources":["../../../src/util/IncludeValuesExtending.ts"],"version":3,"file":"IncludeValuesExtending.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/api",
-  "version": "2.2.0-beta.2",
+  "version": "2.2.0-beta.21",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.26.5",
-    "@microsoft/api-extractor": "^7.49.1",
+    "@microsoft/api-extractor": "^7.52.7",
     "ts-expect": "^1.3.0",
     "typescript": "~5.5.4",
     "@osdk/monorepo.api-extractor": "~0.1.0-beta.1",