Merge pull request #24 from Coder-Spirit/issue-10-deno-support

castarco · web-flow · commit 2c767498839b · 2021-04-03T14:41:02.000+02:00
Denopkg support
diff --git a/.hooks/pre-commit b/.hooks/pre-commit
@@ -1,3 +1,7 @@
 #!/bin/sh
 
-yarn lint && yarn test
+yarn clean:deno && \
+yarn build:deno && \
+git add ./nominal/deno && \
+yarn lint && \
+yarn test
diff --git a/README.md b/README.md
@@ -37,12 +37,15 @@ zero runtime overhead.
 npm install @coderspirit/nominal
 
 # Or with Yarn:
-yarn install @coderspirit/nominal
+yarn add @coderspirit/nominal
 ```
 
 ### Deno
 
-Pending explanation.
+`Nominal` is served through different CDNs
+```typescript
+import { ... } from 'https://denopkg.com/Coder-Spirit/nominal@[VERSION]/nominal/deno/index.ts'
+```
 
 ## Brands
 
diff --git a/nominal/.eslintrc.js b/nominal/.eslintrc.js
@@ -37,7 +37,7 @@ module.exports = {
     quotes: ['error', 'single', { avoidEscape: true }],
     'sort-imports': 'error',
   },
-  ignorePatterns: ['*.js', 'tsconfig.json', 'dist/**/*'],
+  ignorePatterns: ['*.js', 'tsconfig.json', 'dist/**/*', 'deno/**/*'],
   overrides: [
     {
       files: ['**/__tests__/**/*.test.ts'],
diff --git a/nominal/README.md b/nominal/README.md
@@ -37,12 +37,15 @@ zero runtime overhead.
 npm install @coderspirit/nominal
 
 # Or with Yarn:
-yarn install @coderspirit/nominal
+yarn add @coderspirit/nominal
 ```
 
 ### Deno
 
-Pending explanation.
+`Nominal` is served through different CDNs
+```typescript
+import { ... } from 'https://denopkg.com/Coder-Spirit/nominal@[VERSION]/nominal/deno/index.ts'
+```
 
 ## Brands
 
diff --git a/nominal/deno/GenericTainted.ts b/nominal/deno/GenericTainted.ts
@@ -0,0 +1,45 @@
+import { SimpleTypeTag } from './internal/UtilTypes.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+import { WithTag } from './WithTag.ts';
+
+export type GenericTainted<
+  BaseType,
+  TaintTag extends string | symbol
+> = BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+  ? // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    BaseType0 extends Partial<Record<infer _K, infer _V>>
+    ? BaseType0 extends
+        | undefined
+        | null
+        | boolean
+        | number
+        | bigint
+        | string
+        | symbol
+        | Date
+      ? BaseType0 & TagsMarker<BaseType0, TypeTags0 & SimpleTypeTag<TaintTag>>
+      : { [P in keyof BaseType0]: GenericTainted<BaseType0[P], TaintTag> } &
+          TagsMarker<
+            {
+              [P in keyof BaseType0]: GenericTainted<BaseType0[P], TaintTag>
+            },
+            TypeTags0 & SimpleTypeTag<TaintTag>
+          >
+    : BaseType0 & TagsMarker<BaseType0, TypeTags0 & SimpleTypeTag<TaintTag>>
+  : // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  BaseType extends Partial<Record<infer _K, infer _V>>
+  ? BaseType extends
+      | undefined
+      | null
+      | boolean
+      | number
+      | bigint
+      | string
+      | symbol
+      | Date
+    ? WithTag<BaseType, TaintTag>
+    : WithTag<
+        { [P in keyof BaseType]: GenericTainted<BaseType[P], TaintTag> },
+        TaintTag
+      >
+  : WithTag<BaseType, TaintTag>
diff --git a/nominal/deno/GenericUntainted.ts b/nominal/deno/GenericUntainted.ts
@@ -0,0 +1,56 @@
+import { GenericTainted } from './GenericTainted.ts';
+import { NegateTag } from './NegateTag.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+
+export type GenericUntainted<
+  BaseType,
+  TaintTag extends string | symbol
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+> = BaseType extends GenericTainted<infer _Irrelevant, TaintTag>
+  ? BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+    ? // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      BaseType0 extends Partial<Record<infer _K, infer _V>>
+      ? BaseType0 extends
+          | undefined
+          | null
+          | boolean
+          | number
+          | bigint
+          | string
+          | symbol
+          | Date
+        ? NegateTag<BaseType0 & TagsMarker<BaseType0, TypeTags0>, TaintTag>
+        : NegateTag<
+            {
+              [P in keyof BaseType0]: GenericUntainted<BaseType0[P], TaintTag>
+            } &
+              TagsMarker<
+                {
+                  [P in keyof BaseType0]: GenericUntainted<
+                    BaseType0[P],
+                    TaintTag
+                  >
+                },
+                TypeTags0
+              >,
+            TaintTag
+          >
+      : NegateTag<BaseType0 & TagsMarker<BaseType0, TypeTags0>, TaintTag>
+    : // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    BaseType extends Partial<Record<infer _K, infer _V>>
+    ? BaseType extends
+        | undefined
+        | null
+        | boolean
+        | number
+        | bigint
+        | string
+        | symbol
+        | Date
+      ? NegateTag<BaseType, TaintTag>
+      : NegateTag<
+          { [P in keyof BaseType]: GenericUntainted<BaseType[P], TaintTag> },
+          TaintTag
+        >
+    : NegateTag<BaseType, TaintTag>
+  : BaseType
diff --git a/nominal/deno/NegateTag.ts b/nominal/deno/NegateTag.ts
@@ -0,0 +1,27 @@
+import { SimpleTypeNegation, SimpleTypeTag } from './internal/UtilTypes.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+
+export type NegateTag<
+  BaseType,
+  TypeTag extends string | symbol
+> = BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+  ? BaseType0 &
+      (TagsMarker<BaseType0, SimpleTypeTag<TypeTag>> extends TagsMarker<
+        BaseType0,
+        TypeTags0
+      >
+        ? Partial<
+            TagsMarker<
+              BaseType0,
+              TypeTags0 extends SimpleTypeTag<TypeTag> & infer RestTypeTags
+                ? RestTypeTags & SimpleTypeNegation<TypeTag>
+                : Omit<TypeTags0, TypeTag> & SimpleTypeNegation<TypeTag>
+            >
+          >
+        : TagsMarker<
+            BaseType0,
+            TypeTags0 extends SimpleTypeTag<TypeTag> & infer RestTypeTags
+              ? RestTypeTags & SimpleTypeNegation<TypeTag>
+              : Omit<TypeTags0, TypeTag> & SimpleTypeNegation<TypeTag>
+          >)
+  : BaseType & Partial<TagsMarker<BaseType, SimpleTypeNegation<TypeTag>>>
diff --git a/nominal/deno/Tainted.ts b/nominal/deno/Tainted.ts
@@ -0,0 +1,4 @@
+import { GenericTainted } from './GenericTainted.ts';
+import { TaintSymbolType } from './internal/Symbols.ts';
+
+export type Tainted<BaseType> = GenericTainted<BaseType, TaintSymbolType>
diff --git a/nominal/deno/Untainted.ts b/nominal/deno/Untainted.ts
@@ -0,0 +1,4 @@
+import { GenericUntainted } from './GenericUntainted.ts';
+import { TaintSymbolType } from './internal/Symbols.ts';
+
+export type Untainted<BaseType> = GenericUntainted<BaseType, TaintSymbolType>
diff --git a/nominal/deno/WithTag.ts b/nominal/deno/WithTag.ts
@@ -0,0 +1,9 @@
+import { SimpleTypeTag } from './internal/UtilTypes.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+
+export type WithTag<
+  BaseType,
+  TypeTag extends string | symbol
+> = BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+  ? BaseType0 & TagsMarker<BaseType0, TypeTags0 & SimpleTypeTag<TypeTag>>
+  : BaseType & TagsMarker<BaseType, SimpleTypeTag<TypeTag>>
diff --git a/nominal/deno/WithTags.ts b/nominal/deno/WithTags.ts
@@ -0,0 +1,9 @@
+import { CompoundTypeTags } from './internal/UtilTypes.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+
+export type WithTags<
+  BaseType,
+  TypeTags extends (string | symbol)[]
+> = BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+  ? BaseType0 & TagsMarker<BaseType0, TypeTags0 & CompoundTypeTags<TypeTags>>
+  : BaseType & TagsMarker<BaseType, CompoundTypeTags<TypeTags>>
diff --git a/nominal/deno/WithoutTag.ts b/nominal/deno/WithoutTag.ts
@@ -0,0 +1,20 @@
+import { SimpleTypeTag } from './internal/UtilTypes.ts';
+import { TagsMarker } from './internal/TagsMarker.ts';
+
+export type WithoutTag<
+  BaseType,
+  TypeTag extends string | symbol
+> = BaseType extends TagsMarker<infer BaseType0, infer TypeTags0>
+  ? TagsMarker<BaseType0, SimpleTypeTag<TypeTag>> extends TagsMarker<
+      BaseType0,
+      TypeTags0
+    >
+    ? BaseType0
+    : BaseType0 &
+        TagsMarker<
+          BaseType0,
+          TypeTags0 extends SimpleTypeTag<TypeTag> & infer RestTypeTags
+            ? RestTypeTags
+            : Omit<TypeTags0, TypeTag>
+        >
+  : BaseType
diff --git a/nominal/deno/WithoutTags.ts b/nominal/deno/WithoutTags.ts
@@ -0,0 +1,22 @@
+import { TagsMarker } from './internal/TagsMarker.ts';
+import { WithoutTag } from './WithoutTag.ts';
+
+export type WithoutTags<
+  BaseType,
+  TypeTags extends (string | symbol)[] | null = null
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+> = BaseType extends TagsMarker<infer BaseType0, infer _TypeTags0>
+  ? TypeTags extends null
+    ? BaseType0
+    : TypeTags extends [infer TypeTag0, ...infer OtherTypeTags]
+    ? TypeTag0 extends string | symbol
+      ? OtherTypeTags extends (string | symbol)[]
+        ? WithoutTags<WithoutTag<BaseType, TypeTag0>, OtherTypeTags>
+        : never
+      : never
+    : TypeTags extends [infer TypeTag0]
+    ? TypeTag0 extends string | symbol
+      ? WithoutTag<BaseType, TypeTag0>
+      : never
+    : BaseType
+  : BaseType
diff --git a/nominal/deno/index.ts b/nominal/deno/index.ts
@@ -0,0 +1,13 @@
+// Tag types
+export type { WithTag } from './WithTag.ts';
+export type { WithTags } from './WithTags.ts';
+export type { WithoutTag } from './WithoutTag.ts';
+export type { WithoutTags } from './WithoutTags.ts';
+export type { NegateTag } from './NegateTag.ts';
+
+// Taint types
+export type { GenericTainted } from './GenericTainted.ts';
+export type { GenericUntainted } from './GenericUntainted.ts';
+
+export type { Tainted } from './Tainted.ts';
+export type { Untainted } from './Untainted.ts';
diff --git a/nominal/deno/internal/Symbols.ts b/nominal/deno/internal/Symbols.ts
@@ -0,0 +1,5 @@
+const TaintSymbol: unique symbol = Symbol('TaintSymbol')
+export type TaintSymbolType = typeof TaintSymbol
+
+export const __BaseType: unique symbol = Symbol('__BaseType')
+export const __TypeTags: unique symbol = Symbol('__TypeTags')
diff --git a/nominal/deno/internal/TagsMarker.ts b/nominal/deno/internal/TagsMarker.ts
@@ -0,0 +1,6 @@
+import { __BaseType, __TypeTags } from './Symbols.ts';
+
+export type TagsMarker<BaseType, TypeTags> = {
+  readonly [__BaseType]: BaseType
+  readonly [__TypeTags]: TypeTags
+}
diff --git a/nominal/deno/internal/UtilTypes.ts b/nominal/deno/internal/UtilTypes.ts
@@ -0,0 +1,18 @@
+export type SimpleTypeTag<TypeTag extends string | symbol> = {
+  [key in TypeTag]: TypeTag
+}
+
+export type SimpleTypeNegation<TypeTag extends string | symbol> = {
+  [key in TypeTag]?: null // It cannot be never, since it extends from everything
+}
+
+export type CompoundTypeTags<
+  TypeTags extends (string | symbol)[]
+> = TypeTags extends [infer TypeTag0, ...infer OtherTypeTags]
+  ? TypeTag0 extends string | symbol
+    ? SimpleTypeTag<TypeTag0> &
+        (OtherTypeTags extends (string | symbol)[]
+          ? CompoundTypeTags<OtherTypeTags>
+          : unknown)
+    : never
+  : unknown
diff --git a/nominal/package.json b/nominal/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@coderspirit/nominal",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Powerful nominal types for your project",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -20,16 +20,19 @@
   "private": false,
   "license": "MIT",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:esm",
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:deno",
     "build:cjs": "tsc -p ./tsconfig.json",
+    "build:deno": "mkdir -p ./deno && cp -r ./src/* ./deno/ && rm -rf ./deno/__tests__ && ts-node ./scripts/adaptDeno.ts",
     "build:esm": "tsc -p ./tsconfig.esm.json && ts-node ./scripts/adaptESM.ts",
-    "clean":"rm -rf ./dist",
+    "clean": "yarn clean:dist && yarn clean:deno",
+    "clean:deno": "rm -rf ./deno/*.ts && rm -rf ./deno/*/*.ts",
+    "clean:dist": "rm -rf ./dist",
     "lint": "yarn lint:tsc && yarn lint:eslint",
     "lint:eslint": "eslint . --ext .js,.ts --max-warnings 0",
     "lint:tsc": "yarn lint:tsc:main && yarn lint:tsc:tests",
     "lint:tsc:main": "tsc -p ./tsconfig.json --noEmit",
     "lint:tsc:tests": "tsc -p ./src/__tests__/tsconfig.json --noEmit",
-    "prepublishOnly": "yarn lint && yarn test && yarn clean && yarn build",
+    "prepublishOnly": "yarn lint && yarn test && yarn build",
     "test": "jest"
   },
   "peerDependencies": {
diff --git a/nominal/scripts/adaptDeno.ts b/nominal/scripts/adaptDeno.ts
@@ -0,0 +1,17 @@
+import { join } from 'path'
+import { processDirectory } from './lib/processFiles'
+
+run()
+  .then(() => {
+    // Do nothing
+  })
+  .catch((e) => {
+    console.log('Unknown Error', e)
+    // eslint-disable-next-line no-process-exit
+    process.exit(1)
+  })
+
+async function run(): Promise<void> {
+  const esmDir = join(__dirname, '..', 'deno')
+  await processDirectory(esmDir, '.ts')
+}
diff --git a/nominal/scripts/adaptESM.ts b/nominal/scripts/adaptESM.ts
diff --git a/nominal/scripts/lib/processFiles.ts b/nominal/scripts/lib/processFiles.ts
diff --git a/nominal/src/index.ts b/nominal/src/index.ts
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ module.exports = {`
`37`	`37`	`quotes: ['error', 'single', { avoidEscape: true }],`
`38`	`38`	`'sort-imports': 'error',`
`39`	`39`	`},`
`40`		`- ignorePatterns: ['.js', 'tsconfig.json', 'dist//'],`
	`40`	`+ ignorePatterns: ['.js', 'tsconfig.json', 'dist//', 'deno/*/'],`
`41`	`41`	`overrides: [`
`42`	`42`	`{`
`43`	`43`	`files: ['/__tests__//*.test.ts'],`