typespec-typescript-emitter 1.2.0 → 2.0.1

package/test/typeguards/simple.test.ts

@@ -0,0 +1,35 @@
+import { Type } from "@typespec/compiler";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Value = string;
+type Target = string;
+
+const tests: [Type["kind"], Value, Target][] = [
+  ["Boolean", "true", "undefined === true"],
+  ["Boolean", "false", "undefined === false"],
+  // ["Intrinsic", ["never", "unknown", "void", "null"]],
+  ["Intrinsic", "never", "false"],
+  ["Intrinsic", "unknown", "true"],
+  ["Intrinsic", "void", "undefined === undefined"],
+  ["Intrinsic", "null", "undefined === null"],
+  ["String", `"stringy"`, `undefined === 'stringy'`],
+  ...[5, 8, 17, 15.55, -4].map(
+    (n) =>
+      ["Number", n.toString(), `undefined === ${n}`] as [
+        Type["kind"],
+        Value,
+        Target,
+      ],
+  ),
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Typeguard, {
+    type: test[0],
+    desc: `simple: ${test[1]}`,
+    source: `alias test = ${test[1]};`,
+    target: test[2],
+    typescriptTransformer: null,
+  });
+});

package/test/typeguards/tuple.test.ts

@@ -0,0 +1,34 @@
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, Source, Target][] = [
+  [
+    "basic, strings",
+    "[string, string]",
+    "Array.isArray(undefined) && (typeof undefined[0] === 'string') && (typeof undefined[1] === 'string')",
+  ],
+  [
+    "mixed",
+    "[string, int32, null, {a: unknown, b: float}]",
+    "Array.isArray(undefined) && (typeof undefined[0] === 'string') && (typeof undefined[1] === 'number') && (undefined[2] === null) && (undefined[3]['a'] !== undefined && (true) &&undefined[3]['b'] !== undefined && (typeof undefined[3]['b'] === 'number'))",
+  ],
+  [
+    "unions",
+    "[string | float, null | unknown]",
+    "Array.isArray(undefined) && ((typeof undefined[0] === 'string') || (typeof undefined[0] === 'number')) && ((undefined[1] === null) || (true))",
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Typeguard, {
+    type: "Tuple",
+    desc: test[0],
+    source: `alias test = ${test[1]};`,
+    target: test[2],
+    typescriptTransformer: null,
+  });
+});

package/test/typeguards/union.test.ts

@@ -0,0 +1,29 @@
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, Source, Target][] = [
+  [
+    "basic",
+    "string | float",
+    "(typeof undefined === 'string') || (typeof undefined === 'number')",
+  ],
+  [
+    "mixed",
+    "[string, int32] | {a: null}",
+    "(Array.isArray(undefined) && (typeof undefined[0] === 'string') && (typeof undefined[1] === 'number')) || (undefined['a'] !== undefined && (undefined['a'] === null))",
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Typeguard, {
+    type: "Union",
+    desc: test[0],
+    source: `alias test = ${test[1]};`,
+    target: test[2],
+    typescriptTransformer: null,
+  });
+});

package/test/typemap/typemap-novis.target.ts

@@ -0,0 +1,38 @@
+
+// WARN this file may be broken by auto formatting.
+// WARN by default in vscode, save: Ctrl+K , Ctrl+Shift+S
+/*
+ * This file is automatically generated by typespec-typescript-emitter.
+ * 
+ * You should not change or manipulate this file, as it will be overwritten.
+ * Instead, change the underlying spec.
+ */
+
+
+import * as test from './test.ts';
+import * as test_inner from './test.inner.ts';
+
+export type types_test = {
+  ['/']: {
+    ['GET']: {
+      request: null
+      response: {status: 200, body: test.Resource}
+    },
+    ['PUT']: {
+      request: test.Resource | test_inner.InnerModel
+      response: {status: 200, body: {
+        statusCode: 200
+      }}
+    }
+  },
+  ['/inner']: {
+    ['DELETE']: {
+      request: test_inner.InnerModel | test_inner.InnerModel2
+      response: {status: 200, body: {
+        statusCode: 200
+      }} | {status: 401, body: {
+        statusCode: 401
+      }}
+    }
+  }
+};

package/test/typemap/typemap.target.ts

@@ -0,0 +1,39 @@
+
+// WARN this file may be broken by auto formatting.
+// WARN by default in vscode, save: Ctrl+K , Ctrl+Shift+S
+/*
+ * This file is automatically generated by typespec-typescript-emitter.
+ * 
+ * You should not change or manipulate this file, as it will be overwritten.
+ * Instead, change the underlying spec.
+ */
+
+
+import * as test from './test.ts';
+import * as test_inner from './test.inner.ts';
+import {Lifecycle, FilterLifecycle} from './lifecycleVisibility.ts';
+
+export type types_test<V extends Lifecycle = Lifecycle.All> = {
+  ['/']: {
+    ['GET']: {
+      request: null
+      response: {status: 200, body: test.Resource<V extends Lifecycle.All ? (Lifecycle.Read) : V>}
+    },
+    ['PUT']: {
+      request: test.Resource<V extends Lifecycle.All ? (Lifecycle.Create | Lifecycle.Update) : V> | test_inner.InnerModel<V extends Lifecycle.All ? (Lifecycle.Create | Lifecycle.Update) : V>
+      response: {status: 200, body: {
+        statusCode: 200
+      }}
+    }
+  },
+  ['/inner']: {
+    ['DELETE']: {
+      request: test_inner.InnerModel<V extends Lifecycle.All ? (Lifecycle.Delete) : V> | test_inner.InnerModel2
+      response: {status: 200, body: {
+        statusCode: 200
+      }} | {status: 401, body: {
+        statusCode: 401
+      }}
+    }
+  }
+};

package/test/typemap/typemap.test.ts

@@ -0,0 +1,48 @@
+import { readFileSync } from "fs";
+import { join } from "path";
+import { expectEmit } from "../helpers/wrapper";
+
+const prepareContents = (s: string): string => {
+  let ret = s;
+  ret = ret.replaceAll(
+    "// WARN this file may be broken by auto formatting.",
+    "",
+  );
+  ret = ret.replaceAll(
+    "// WARN by default in vscode, save: Ctrl+K , Ctrl+Shift+S",
+    "",
+  );
+  return `/* eslint-disable */${ret}`;
+};
+
+expectEmit(
+  "routed typemap",
+  {
+    ["main.tsp"]: readFileSync(
+      join(__dirname, "..", "helpers", "integrationTest.tsp"),
+      "utf8",
+    ),
+  },
+  {
+    "routedTypemap_test.ts": prepareContents(
+      readFileSync(join(__dirname, "typemap.target.ts"), "utf8"),
+    ),
+  },
+  { "enable-routed-typemap": true },
+);
+
+expectEmit(
+  "routed typemap - no visibility",
+  {
+    ["main.tsp"]: readFileSync(
+      join(__dirname, "..", "helpers", "integrationTest-novis.tsp"),
+      "utf8",
+    ),
+  },
+  {
+    "routedTypemap_test.ts": prepareContents(
+      readFileSync(join(__dirname, "typemap-novis.target.ts"), "utf8"),
+    ),
+  },
+  { "enable-routed-typemap": true },
+);

package/test/types/combined.test.ts

@@ -0,0 +1,71 @@
+import { readFileSync } from "fs";
+import { join } from "path";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+const input = readFileSync(
+  join(__dirname, "..", "helpers", "largeModel.tsp"),
+  "utf8",
+);
+
+const target = `
+FilterLifecycle<{
+  id_onlyRead: number,
+  name: string,
+  aliasedName?: string,
+  date: string,
+  time: string,
+  created_onlyCreate: number,
+  tuple_strIntModel_readQuery: [string, number, {inmodel_union: null | unknown}],
+  nested?: {
+    availability: boolean
+  },
+  array: (string)[],
+  array_union: (string | number)[],
+  record: {[k: string]: string},
+  record_union: {[k: string]: string | number},
+  nested_deleteQuery: {
+    str_onlyQuery: string,
+    aliasedModel: {str: string,fl: number,nested: {int: number}},
+    modelWithVis: {
+      a: 'a',
+      seven_onlyDelete: 7
+    }
+  },
+  nestedInnerVis: {
+    unk?: unknown,
+    void_onlyUpdate: void
+  },
+  tupleWithUnion: [string, number | boolean]
+}, {
+  'id_onlyRead': {vis: [Lifecycle.Read]},
+  'created_onlyCreate': {vis: [Lifecycle.Create]},
+  'tuple_strIntModel_readQuery': {vis: [Lifecycle.Read, Lifecycle.Query]},
+  'nested_deleteQuery': {
+    vis: [Lifecycle.Delete, Lifecycle.Query],
+    nested: {
+      'str_onlyQuery': {vis: [Lifecycle.Query]},
+      'modelWithVis': {
+        nested: {
+          'seven_onlyDelete': {vis: [Lifecycle.Delete]}
+        }
+      }
+    }
+  },
+  'nestedInnerVis': {
+    nested: {
+      'void_onlyUpdate': {vis: [Lifecycle.Update]}
+    }
+  }
+}, V>
+`;
+
+expectResolution(Resolver.Type, {
+  type: "Model",
+  desc: "combined",
+  source: input,
+  target: target,
+  config: {
+    "serializable-date-types": true,
+  },
+});

package/test/types/enum.test.ts

@@ -0,0 +1,57 @@
+import { EmitterOptions } from "../../src/lib";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, Source, Target, Partial<EmitterOptions>][] = [
+  [
+    "basic, not nominal",
+    "enum test {val1, val2}",
+    "{val1,val2}",
+    { "string-nominal-enums": false },
+  ],
+  [
+    "basic, nominal",
+    "enum test {val1, val2}",
+    "{val1 = 'val1',val2 = 'val2'}",
+    { "string-nominal-enums": true },
+  ],
+  [
+    "shifted, not nominal",
+    "enum test {val1: 1, val2: 2}",
+    "{val1 = 1,val2 = 2}",
+    { "string-nominal-enums": false },
+  ],
+  [
+    "shifted, nominal",
+    "enum test {val1: 1, val2: 2}",
+    "{val1 = 1,val2 = 2}",
+    { "string-nominal-enums": true },
+  ],
+  [
+    "string, not nominal",
+    'enum test {val1: "value1", val2: "value2"}',
+    "{val1 = 'value1',val2 = 'value2'}",
+    { "string-nominal-enums": false },
+  ],
+  [
+    "string, nominal",
+    'enum test {val1: "value1", val2: "value2"}',
+    "{val1 = 'value1',val2 = 'value2'}",
+    { "string-nominal-enums": true },
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Enum",
+    desc: test[0],
+    source: test[1],
+    target: test[2],
+    config: test[3],
+    typescriptTransformer: (tsp) => `enum test ${tsp}`,
+  });
+});

package/test/types/model.indexed.test.ts

@@ -0,0 +1,46 @@
+import { Model } from "@typespec/compiler";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, string, Source, Target][] = [
+  ["Array", "simple", "string[]", "(string)[]"],
+  ["Array", "union", "(string | int32)[]", "(string | number)[]"],
+  ["Array", "tuple", "[string, int32][]", "([string, number])[]"],
+  ["Array", "model", "{str: string}[]", "({str: string})[]"],
+  ["Record", "simple", "Record<string>", "{[k: string]: string}"],
+  [
+    "Record",
+    "union",
+    "Record<string | int32>",
+    "{[k: string]: string | number}",
+  ],
+  [
+    "Record",
+    "tuple",
+    "Record<[string, int32]>",
+    "{[k: string]: [string, number]}",
+  ],
+  [
+    "Record",
+    "model",
+    "Record<{str?: string}>",
+    "{[k: string]: {str?: string}}",
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Model",
+    desc: `${test[0]}: ${test[1]}`,
+    source: `alias test = ${test[2]};`,
+    target: test[3],
+    test: (t) =>
+      (t as Model).name === test[0]
+        ? true
+        : `model name was ${(t as Model).name}`,
+  });
+});

package/test/types/model.shaped.test.ts

@@ -0,0 +1,23 @@
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+const tests: [string, string][] = [
+  ["{s: string}", "{s: string}"],
+  ["{s?: string}", "{s?: string}"],
+  ["{m: {s: float | int32}}", "{m: {s: number | number}}"],
+  ["{a: {s: float}[]}", "{a: ({s: number})[]}"],
+  ["{a: {s?: float}[]}", "{a: ({s?: number})[]}"],
+  [
+    "{r: Record<[string, int32]>, a: string[], f: never}",
+    "{r: {[k: string]: [string, number]},a: (string)[],f: never}",
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Model",
+    desc: test[0],
+    source: `alias test = ${test[0]};`,
+    target: test[1],
+  });
+});

package/test/types/scalar.test.ts

@@ -0,0 +1,53 @@
+import { Scalar } from "@typespec/compiler";
+import { EmitterOptions } from "../../src/lib";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Target = string;
+
+const tests: [Name, Target, Partial<EmitterOptions>?][] = [
+  ["boolean", "boolean"],
+  ["bytes", "Uint8Array"],
+  ["duration", "number"],
+  ["numeric", "number"],
+  ["plainTime", "string"],
+  ["string", "string"],
+  ["url", "string"],
+
+  // date / time types
+  ...["offsetDateTime", "plainDate", "utcDateTime"].map(
+    (t) =>
+      [t, "Date", { "serializable-date-types": false }] as [
+        string,
+        string,
+        any,
+      ],
+  ),
+  ...["offsetDateTime", "plainDate", "utcDateTime"].map(
+    (t) =>
+      [t, "string", { "serializable-date-types": true }] as [
+        string,
+        string,
+        any,
+      ],
+  ),
+  ["unixTimestamp32", "Date", { "serializable-date-types": false }],
+  ["unixTimestamp32", "number", { "serializable-date-types": true }],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Scalar",
+    desc: test[2]
+      ? `{${Object.entries(test[2]).map((p) => `${p[0]}: ${p[1]}`)}}`
+      : undefined,
+    source: `alias test = ${test[0]};`,
+    target: test[1],
+    test: (t) =>
+      (t as Scalar).name === test[0]
+        ? true
+        : `scalar name was ${(t as Scalar).name}`,
+    config: test[2],
+  });
+});

package/test/types/simple.test.ts

@@ -0,0 +1,20 @@
+import { Type } from "@typespec/compiler";
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+const tests: [Type["kind"], any[]][] = [
+  ["Boolean", ["true", "false"]],
+  ["Intrinsic", ["never", "unknown", "void", "null"]],
+  ["Number", [5, 8, 17, 15.55, -4]],
+  ["String", [`""`, `"someString"`]],
+];
+
+tests.forEach((test) => {
+  test[1].forEach((v) =>
+    expectResolution(Resolver.Type, {
+      type: test[0],
+      source: `alias test = ${v};`,
+      target: v.toString().replaceAll('"', "'"),
+    }),
+  );
+});

package/test/types/tuple.test.ts

@@ -0,0 +1,29 @@
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, Source, Target][] = [
+  ["basic, strings", "[string, string]", "[string, string]"],
+  [
+    "mixed",
+    "[string, int32, null, {a: unknown, b: float}]",
+    "[string, number, null, {a: unknown,b: number}]",
+  ],
+  [
+    "unions",
+    "[string | float, null | unknown]",
+    "[string | number, null | unknown]",
+  ],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Tuple",
+    desc: test[0],
+    source: `alias test = ${test[1]};`,
+    target: test[2],
+  });
+});

package/test/types/union.test.ts

@@ -0,0 +1,20 @@
+import { Resolver } from "../../src/resolve/Resolvable_helpers";
+import { expectResolution } from "../helpers/wrapper";
+
+type Name = string;
+type Source = string;
+type Target = string;
+
+const tests: [Name, Source, Target][] = [
+  ["basic", "string | float", "string | number"],
+  ["mixed", "[string, int32] | {a: null}", "[string, number] | {a: null}"],
+];
+
+tests.forEach((test) => {
+  expectResolution(Resolver.Type, {
+    type: "Union",
+    desc: test[0],
+    source: `alias test = ${test[1]};`,
+    target: test[2],
+  });
+});

package/tsconfig.json

@@ -13,5 +13,6 @@
     /* Linting */
     "strict": true
   },
+  "exclude": ["test"],
   "include": ["src"]
 }

package/dist/src/emit_mapped_types.d.ts

@@ -1,2 +0,0 @@
-import { EmitContext, Namespace } from "@typespec/compiler";
-export declare const emitRoutedTypemap: (context: EmitContext, namespace: Namespace) => string;