Support CommonJS by properly setting the exports field and using `.…

…npmignore` to filter out filtes to ignore (ourzora#225)

* Revert "Revert "Adding exports to protocol-sdk package.json (ourzora#214)" (ourzora#223)"

This reverts commit 8a87809.

* added npm ignore

* applied exports fixes to other dependent package

.changeset/empty-sloths-cheer.md

@@ -0,0 +1,7 @@
+---
+"@zoralabs/protocol-deployments": patch
+"@zoralabs/zora-1155-contracts": patch
+"@zoralabs/protocol-sdk": patch
+---
+
+Publishing package in format that supports commonjs imports by specifying exports

.npmignore

@@ -0,0 +1,18 @@
+# this defines what should be ignored
+# for npm publishing.  it overrides the .gitignore
+# for npm publishing.  We need this to be defined separately
+# so we can include the dist folder.
+tsconfig.build.json
+**/*test-integration
+**/*.test.ts
+.turbo
+tsup.config.ts
+**/*.env*
+wagmi.config.ts
+cache
+lcov.info
+.storage-layout
+**/*.puml
+**/*.sh
+test
+out

packages/1155-contracts/package.json

@@ -4,9 +4,18 @@
   "repository": "[email protected]:ourzora/zora-protocol.git",
   "author": "Iain <[email protected]>",
   "license": "MIT",
-  "main": "./dist/index.js",
-  "types": "./dist/package/index.d.ts",
   "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    }
+  },
   "scripts": {
     "dev": "FOUNDRY_PROFILE=dev forge test --watch -vvv",
     "test": "forge test -vv",
@@ -25,16 +34,6 @@
     "storage-inspect:generate": "./script/storage-check.sh generate ZoraCreator1155Impl ZoraCreator1155FactoryImpl",
     "update-contract-version": "node script/update-contract-version.mjs"
   },
-  "files": [
-    "dist/",
-    "src/",
-    "out/",
-    "addresses/",
-    "chainConfigs/",
-    "package/",
-    "abis/",
-    "_imagine/"
-  ],
   "dependencies": {
     "solmate": "6.1.0",
     "forge-std": "https://github.com/foundry-rs/forge-std#705263c95892a906d7af65f0f73ce8a4a0c80b80",

packages/1155-contracts/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "zoralabs-tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "lib": ["es2021", "DOM"],
+    "baseUrl": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["node_modules/**", "dist/**"],
+  "include": ["package/**/*.ts"]
+}

packages/1155-contracts/tsup.config.ts

@@ -1,10 +1,11 @@
-import { defineConfig } from 'tsup'
+import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ['package/index.ts'],
+  entry: ["package/index.ts"],
   sourcemap: true,
   clean: true,
   dts: false,
-  format: ['cjs', 'esm'],
-  onSuccess: 'tsc --emitDeclarationOnly --declaration --declarationMap'
-})
+  format: ["cjs", "esm"],
+  onSuccess:
+    "tsc --project tsconfig.build.json  --emitDeclarationOnly --declaration --declarationMap",
+});

packages/protocol-deployments/.npmignore

@@ -0,0 +1 @@
+scripts

packages/protocol-deployments/package.json

@@ -3,14 +3,18 @@
   "version": "0.1.1",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
-  "main": "./dist/index.js",
-  "types": "./dist/src/index.d.ts",
-  "files": [
-    "dist/",
-    "src/",
-    "json/"
-  ],
   "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    }
+  },
   "scripts": {
     "build": "yarn wagmi && yarn bundle-configs && tsup",
     "bundle-configs": "tsx scripts/bundle-configs.ts && yarn prettier",

packages/protocol-deployments/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "zoralabs-tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "lib": ["es2021", "DOM"],
+    "baseUrl": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["node_modules/**", "dist/**"],
+  "include": ["src/**/*.ts"]
+}

packages/protocol-deployments/tsup.config.ts

@@ -6,5 +6,6 @@ export default defineConfig({
   clean: true,
   dts: false,
   format: ["cjs", "esm"],
-  onSuccess: "tsc --emitDeclarationOnly --declaration --declarationMap",
+  onSuccess:
+    "tsc --project tsconfig.build.json  --emitDeclarationOnly --declaration --declarationMap",
 });

packages/protocol-sdk/.npmignore

@@ -0,0 +1 @@
+src/anvil.ts

packages/protocol-sdk/package.json

@@ -3,9 +3,18 @@
   "version": "0.5.5",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    }
+  },
   "scripts": {
     "build": "tsup",
     "prepack": "yarn build",

packages/protocol-sdk/tsup.config.js → packages/protocol-sdk/tsup.config.ts

@@ -7,5 +7,6 @@ export default defineConfig({
   tsconfig: "tsconfig.build.json",
   dts: false,
   format: ["cjs", "esm"],
-  onSuccess: "tsc --project tsconfig.build.json --emitDeclarationOnly --declaration --declarationMap",
+  onSuccess:
+    "tsc --project tsconfig.build.json --emitDeclarationOnly --declaration --declarationMap",
 });