chore: some suggestions for repo setup (#12)

* chore(deps): switch to yarn v4 which has version plugin included

* chore: reduce number of tsconfigs

* chore: set release strategy

* chore: only export types from types.ts

.yarn/versions/02453743.yml

@@ -0,0 +1,2 @@
+releases:
+  "@kiltprotocol/dip-sdk": patch

.yarnrc.yml

@@ -1,11 +1,11 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
 nodeLinker: node-modules
 
 npmPublishAccess: public
 
 npmPublishRegistry: "https://registry.npmjs.org"
 
-plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
-    spec: "@yarnpkg/plugin-version"
-
-yarnPath: .yarn/releases/yarn-3.6.1.cjs
+yarnPath: .yarn/releases/yarn-4.2.2.cjs

package.json

@@ -39,14 +39,14 @@
   "license": "BSD-4-Clause",
   "main": "./dist/cjs/index.js",
   "name": "@kiltprotocol/dip-sdk",
-  "packageManager": "yarn@3.6.1",
+  "packageManager": "yarn@4.2.2",
   "repository": "github:kiltprotocol/dip-sdk",
   "scripts": {
     "build": "yarn build:cjs && yarn build:esm",
     "build:cjs": "run -T tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
     "build:docs": "typedoc --theme default --out docs/api --tsconfig tsconfig.docs.json && touch docs/.nojekyll",
     "build:esm": "run -T tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
-    "check": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
     "clean": "yarn rimraf -g */{cjs,esm}",
     "clean:docs": "rimraf docs/api",
     "lint": "eslint --ext .ts .",
@@ -60,4 +60,4 @@
   "type": "module",
   "types": "./dist/cjs/index.d.ts",
   "version": "0.0.0"
-}
+}

src/dipProof/extensions/index.ts

@@ -5,6 +5,4 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./types.js"
-
 export * as timeBoundDidSignature from "./timeBoundDidSignature.js"

src/dipProof/extensions/types.ts

@@ -5,4 +5,9 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./timeBoundDidSignature.js"
+export type {
+  TimeBoundDidSignatureConsumerOpts,
+  TimeBoundDidSignatureOpts,
+  TimeBoundDidSignatureProviderOpts,
+  TimeBoundDidSignatureRes,
+} from "./timeBoundDidSignature.js"

src/dipProof/index.ts

@@ -5,7 +5,5 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./types.js"
-
 export * from "./subjectIdentity.js"
 export * as extensions from "./extensions/index.js"

src/dipProof/types.ts

@@ -5,5 +5,8 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./subjectIdentity.js"
+export type {
+  DipIdentityProofOpts,
+  DipIdentityProofRes,
+} from "./subjectIdentity.js"
 export type * from "./extensions/types.js"

src/stateProof/index.ts

@@ -5,7 +5,5 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./types.js"
-
 export * from "./providerStateRoot.js"
 export * from "./subjectDipCommitment.js"

src/stateProof/types.ts

@@ -5,5 +5,11 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./providerStateRoot.js"
-export type * from "./subjectDipCommitment.js"
+export type {
+  ProviderStateRootProofOpts,
+  ProviderStateRootProofRes,
+} from "./providerStateRoot.js"
+export type {
+  DipCommitmentProofOpts,
+  DipCommitmentProofRes,
+} from "./subjectDipCommitment.js"

src/types.ts

@@ -5,6 +5,10 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type * from "./stateProof/index.js"
-export type * from "./dipProof/index.js"
-export type * from "./sibling.js"
+export type * from "./stateProof/types.js"
+export type * from "./dipProof/types.js"
+export type {
+  DipSiblingBaseProofInput,
+  DipSiblingBaseProofRes,
+  GenerateDipSubmittableExtrinsicInput,
+} from "./sibling.js"

tsconfig.cjs.json

@@ -1,10 +1,9 @@
 {
-  "extends": "./tsconfig.base.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
     "outDir": "dist/cjs",
     "module": "CommonJS",
     "declaration": true
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules"]
 }

tsconfig.esm.json

@@ -1,10 +1,9 @@
 {
-  "extends": "./tsconfig.base.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
     "outDir": "dist/esm",
     "module": "Node16",
     "declaration": true
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules"]
 }

tsconfig.json

@@ -1,9 +1,19 @@
 {
-  "extends": "./tsconfig.base.json",
   "compilerOptions": {
     "module": "Node16",
-    "moduleResolution": "Node16",
-    "noEmit": true
+    "target": "ES2020",
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
+    "sourceMap": false,
+    "declarationMap": false,
+    "esModuleInterop": false,
+    "skipLibCheck": true
   },
+  "exclude": ["node_modules", "dist"],
   "include": ["tests/**/*.ts", "src/**/*.ts"]
 }