Factor out common types that don't depend on the exact schema into schema-dts-lib

package.json

@@ -71,6 +71,7 @@
   "type": "module",
   "workspaces": [
     "packages/schema-dts-gen",
+    "packages/schema-dts-lib",
     "packages/schema-dts"
   ]
 }

packages/schema-dts-gen/src/ts/helper_types.ts

@@ -13,21 +13,8 @@ import {arrayOf} from './util/arrayof.js';
 import {withComments} from './util/comments.js';
 import {typeUnion} from './util/union.js';
 
-function IdPropertyNode() {
-  return withComments(
-    'IRI identifying the canonical address of this object.',
-    factory.createPropertySignature(
-      /* modifiers= */ [],
-      factory.createStringLiteral('@id'),
-      /* questionToken= */ undefined,
-      /* typeNode= */
-      factory.createTypeReferenceNode('string', /*typeArguments=*/ []),
-    ),
-  );
-}
-
 function WithContextType(context: Context) {
-  // export type WithContext<T extends Thing> = T & { "@context": TYPE_NODE }
+  // export interface WithContext<T extends JsonLdObject | string> extends Exclude<T, string> { "@context": TYPE_NODE }
   return withComments(
     'Used at the top-level node to indicate the context for the JSON-LD ' +
       'objects used. The context provided in this type is compatible ' +
@@ -39,10 +26,13 @@ function WithContextType(context: Context) {
         factory.createTypeParameterDeclaration(
           /*modifiers=*/ [],
           'T' /*constraint=*/,
-          factory.createTypeReferenceNode(
-            'Thing',
-            /*typeArguments=*/ undefined,
-          ),
+          factory.createUnionTypeNode([
+            factory.createTypeReferenceNode(
+              'JsonLdObject',
+              /*typeArguments=*/ undefined,
+            ),
+            factory.createKeywordTypeNode(SyntaxKind.StringKeyword),
+          ]),
         ),
       ],
       factory.createIntersectionTypeNode([
@@ -105,6 +95,42 @@ export function SchemaValueReference(
 
 export function HelperTypes(context: Context, {hasRole}: {hasRole: boolean}) {
   return [
+    factory.createImportDeclaration(
+      /*modifiers=*/ [],
+      factory.createImportClause(
+        SyntaxKind.TypeKeyword,
+        /*name=*/ undefined,
+        factory.createNamedImports([
+          factory.createImportSpecifier(
+            /*isTypeOnly=*/ false,
+            /*propertyName=*/ undefined,
+            /*name=*/ factory.createIdentifier('JsonLdObject'),
+          ),
+          factory.createImportSpecifier(
+            /*isTypeOnly=*/ false,
+            /*propertyName=*/ undefined,
+            /*name=*/ factory.createIdentifier('IdReference'),
+          ),
+        ]),
+      ),
+      factory.createStringLiteral('schema-dts-lib'),
+    ),
+    factory.createExportDeclaration(
+      /*modifiers=*/ [],
+      /*isTypeOnly=*/ true,
+      factory.createNamedExports([
+        factory.createExportSpecifier(
+          /*isTypeOnly=*/ false,
+          /*propertyName=*/ undefined,
+          /*name=*/ factory.createIdentifier('JsonLdObject'),
+        ),
+        factory.createExportSpecifier(
+          /*isTypeOnly=*/ false,
+          /*propertyName=*/ undefined,
+          /*name=*/ factory.createIdentifier('IdReference'),
+        ),
+      ]),
+    ),
     WithContextType(context),
     GraphType(context),
     factory.createTypeAliasDeclaration(
@@ -143,12 +169,6 @@ export function HelperTypes(context: Context, {hasRole}: {hasRole: boolean}) {
         ),
       ),
     ),
-    factory.createTypeAliasDeclaration(
-      /*modifiers=*/ [],
-      IdReferenceName,
-      /*typeParameters=*/ [],
-      factory.createTypeLiteralNode([IdPropertyNode()]),
-    ),
     InputActionConstraintsType,
     OutputActionConstraintsType,
     WithActionConstraintsType,

packages/schema-dts-gen/test/baselines/category_test.ts

@@ -45,19 +45,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/comments_test.ts

@@ -65,19 +65,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/data_type_union_test.ts

@@ -43,19 +43,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/default_ontology_test.ts

@@ -30,19 +30,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/deprecated_objects_test.ts

@@ -66,19 +66,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/duplicate_comments_test.ts

@@ -47,19 +47,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/enum_skipped_test.ts

@@ -43,19 +43,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/inheritance_multiple_test.ts

@@ -47,19 +47,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/inheritance_one_test.ts

@@ -42,19 +42,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;

packages/schema-dts-gen/test/baselines/nested_datatype_test.ts

@@ -57,19 +57,17 @@ test(`baseline_${basename(import.meta.url)}`, async () => {
   );
 
   expect(actual).toMatchInlineSnapshot(`
-"/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
-export type WithContext<T extends Thing> = T & {
+"import type { JsonLdObject, IdReference } from "schema-dts-lib";
+export type { JsonLdObject, IdReference };
+/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
+export type WithContext<T extends JsonLdObject | string> = T & {
     "@context": "https://schema.org";
 };
 export interface Graph {
     "@context": "https://schema.org";
     "@graph": readonly Thing[];
 }
 type SchemaValue<T> = T | readonly T[];
-type IdReference = {
-    /** IRI identifying the canonical address of this object. */
-    "@id": string;
-};
 type InputActionConstraints<T extends ActionBase> = Partial<{
     [K in Exclude<keyof T, \`@\${string}\`> as \`\${string & K}-input\`]: PropertyValueSpecification | string;
 }>;