Merge pull request #16 from Network-Goods/fix/package_release_bugs

Fix/package release bugs

Author: bitbeckers

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI - SDK
+
+env:
+  GRAPH_URL: ${{ secrets.GRAPH_URL }}
+  NFT_STORAGE_TOKEN: ${{ secrets.NFT_STORAGE_TOKEN }}
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build-and-test:
+    environment: test
+    # The type of runner that the job will run on
+    name: Build and test SDK
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "yarn"
+          node-version: "16"
+
+      - name: "Install the dependencies"
+        run: "yarn install --immutable"
+
+      - name: "Run Jest"
+        run: "yarn test"

docs/RELEASE.md

@@ -1,5 +1,31 @@
 # Release notes
 
+## 0.0.12
+
+* JSON assertion
+
+## 0.0.11
+
+* Refactored to use ESM ("type": "module")
+* Refactered Mocha to Jest
+* Added basic assertions for the exported interface functions
+* Updated build scripts for stabler releasing
+* Enforce graphclient dependencies
+
+... [Numbers got lost in testing releasing]
+## 0.0.6
+
+* Added graphql deps to solve publishing blocker
+
+## 0.0.5
+
+* Added `storeData` to upload Blobs to IPFS for non-metadata data upload
+* Added `getData` to retrieve those blobs
+* Refactored GraphQL queries to use graphclient generated SDK for better typings
+* Updated Graph client and types
+* Export ESM module only
+* Add allowList property to `HypercertMetaData`
+
 ## 0.0.4
 
 * Added `ClaimById` query

jest.config.ts

@@ -0,0 +1,25 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  setupFiles: ["./test/setup-tests.ts"],
+  preset: "ts-jest/presets/js-with-ts-esm", // or other ESM presets,
+  rootDir: ".",
+  moduleDirectories: ["node_modules", "src", ".graphclient"],
+  verbose: false,
+  resolver: "ts-jest-resolver",
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+    // ".graphclient/(.*)": "<rootDir>/.graphclient/$1",
+    // "resources/(.*)": "<rootDir>/resources/$1",
+    // "types/(.*)": "<rootDir>/src/types/$1",
+  },
+  transform: {
+    // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest`
+    // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest`
+    "^.+\\.[tj]sx?$": [
+      "ts-jest",
+      {
+        useESM: true,
+      },
+    ],
+  },
+};

package.json

@@ -1,72 +1,85 @@
 {
   "name": "@network-goods/hypercerts-sdk",
-  "version": "0.0.4",
+  "version": "0.0.12",
   "description": "SDK for hypercerts protocol",
   "repository": "git@github.com:Network-Goods/hypercerts-sdk.git",
   "author": "Network Goods",
   "license": "MIT",
+  "source": "src/index.ts",
   "typedocMain": "src/index.ts",
-  "main": "./lib/cjs/src/index.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
-    "lib/**/*"
+    "lib",
+    "README.md",
+    "package.json"
   ],
   "dependencies": {
+    "@graphprotocol/client-add-source-name": "latest",
+    "@graphprotocol/client-auto-pagination": "latest",
+    "@graphprotocol/client-auto-type-merging": "latest",
+    "@graphql-mesh/cache-localforage": "latest",
+    "@graphql-mesh/cross-helpers": "latest",
+    "@graphql-mesh/graphql": "latest",
+    "@graphql-mesh/http": "latest",
+    "@graphql-mesh/json-schema": "latest",
+    "@graphql-mesh/merger-bare": "latest",
+    "@graphql-mesh/merger-stitching": "latest",
+    "@graphql-mesh/plugin-mock": "latest",
+    "@graphql-mesh/runtime": "latest",
+    "@graphql-mesh/store": "latest",
+    "@graphql-mesh/transform-filter-schema": "latest",
+    "@graphql-mesh/transform-prefix": "latest",
+    "@graphql-mesh/transform-prune": "latest",
+    "@graphql-mesh/transform-rename": "latest",
+    "@graphql-mesh/transform-type-merging": "latest",
+    "@graphql-mesh/utils": "latest",
+    "@graphql-tools/merge": "latest",
     "@network-goods/hypercerts-protocol": "0.0.6",
+    "@types/jest": "^29.2.5",
     "ajv": "^8.11.2",
     "axios": "^1.2.2",
     "ethers": "^5.7.2",
     "graphql": "^16.6.0",
     "ipfs-core": "^0.17.0",
+    "jest": "^29.3.1",
     "loglevel": "^1.8.1",
     "mime": "^3.0.0",
     "nft.storage": "^7.0.0",
+    "ts-jest": "^29.0.3",
     "ts-mocha": "^10.0.0"
   },
   "devDependencies": {
     "@graphprotocol/client-cli": "^2.2.15",
     "@types/chai": "^4.3.4",
-    "@types/mocha": "^10.0.1",
     "@types/node": "^18.11.17",
     "chai": "^4.3.7",
     "it-all": "^2.0.0",
     "json-schema-to-typescript": "^11.0.2",
-    "mocha": "^10.1.0",
     "mockipfs": "^0.3.0",
     "mockttp": "^3.6.1",
     "nyc": "^15.1.0",
     "shx": "^0.3.4",
-    "ts-mocha": "^10.0.0",
+    "ts-jest-resolver": "^2.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.0"
   },
   "resolutions": {
     "graphql": "^16.6.0"
   },
   "scripts": {
-    "graph:build": "yarn graph:build:client && tsc",
-    "graph:build:client": "graphclient build",
+    "graph:build": "rm -rf ./src/.graphclient && NODE_OPTIONS='--loader ts-node/esm' graphclient build --throwOnInvalidConfig && mv .graphclient ./src/.graphclient",
     "graph:compile": "graphql-codegen",
     "graph:serve": "graphclient serve-dev",
-    "graph:tsc": "tsc",
-    "graph:test": "echo \"Error: No tests\" && exit 1",
     "graph:watch": "graphql-codegen -w",
-    "clean": "rm -rf ./lib",
-    "build": "npm run clean && npm run graph:build &&npm run build:esm && npm run build:cjs",
-    "build:esm": "tsc -p ./tsconfig.esm.json && mv ./lib/esm/src/index.js ./lib/esm/src/index.mjs",
-    "build:cjs": "tsc -p ./tsconfig.cjs.json",
-    "prepack": "npm run build",
-    "test": "ts-mocha -r dotenv/config test/*.ts"
+    "graph:build:esm": "rm -rf ./src/.graphclient && NODE_OPTIONS='--loader ts-node/esm' graphclient build --filetype js --throwOnInvalidConfig && mv .graphclient ./src/.graphclient",
+    "clean": "rm -rf ./lib && rm -rf ./src/types",
+    "build": "yarn clean && yarn types:json && yarn graph:build:esm && yarn build:esm",
+    "build:esm": "tsc",
+    "prebuild": "yarn clean",
+    "prepack": "yarn build",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
+    "types:json": "yarn run json2ts -i './src/resources/schema/' -o 'src/types' --cwd './src/resources/schema' --no-declareExternallyReferenced"
   },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./lib/esm/types/src/index.d.ts",
-        "default": "./lib/esm/src/index.mjs"
-      },
-      "require": {
-        "types": "./lib/cjs/types/src/index.d.ts",
-        "default": "./lib/cjs/src/index.js"
-      }
-    }
-  }
+  "type": "module"
 }