From 3b632a1c29a9afbc26419f7fad068405cb871315 Mon Sep 17 00:00:00 2001 From: Denis Carriere Date: Wed, 7 Aug 2024 16:06:01 -0400 Subject: [PATCH] update export module types --- .husky/pre-commit | 3 -- data/chains/V2/arbone/meta.ts | 10 ++-- data/chains/V2/arweave/meta.ts | 10 ++-- data/chains/V2/avalanche/meta.ts | 12 +++-- data/chains/V2/index.ts | 10 ++-- index.ts | 9 ++-- package-lock.json | 4 +- package.json | 16 +++--- test.ts | 5 ++ tsconfig.json | 85 ++------------------------------ types/index.ts | 12 ++--- types/svg.d.ts | 4 ++ 12 files changed, 62 insertions(+), 118 deletions(-) delete mode 100644 .husky/pre-commit create mode 100644 test.ts create mode 100644 types/svg.d.ts diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100644 index 21d16ae..0000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,3 +0,0 @@ -bun run generate -npm run generate_v1 -git add . \ No newline at end of file diff --git a/data/chains/V2/arbone/meta.ts b/data/chains/V2/arbone/meta.ts index a76d0a5..c45c783 100644 --- a/data/chains/V2/arbone/meta.ts +++ b/data/chains/V2/arbone/meta.ts @@ -1,6 +1,12 @@ import { ___InternalChain } from '../../../../types/chain.types'; -const meta: ___InternalChain = { +import branded from "./arbone.branded.svg" +import dark from "./arbone.dark.svg" +import light from "./arbone.light.svg" + +export { branded, dark, light }; + +export const meta: ___InternalChain = { id: 'arbone', graph_id: 'arbitrum-one', name: 'Arbitrum One', @@ -36,5 +42,3 @@ const meta: ___InternalChain = { website: 'https://arbitrum.io/', }, }; - -export default meta; diff --git a/data/chains/V2/arweave/meta.ts b/data/chains/V2/arweave/meta.ts index 0b3a034..106ea90 100644 --- a/data/chains/V2/arweave/meta.ts +++ b/data/chains/V2/arweave/meta.ts @@ -1,6 +1,12 @@ import { ___InternalChain } from '../../../../types/chain.types'; -const meta: ___InternalChain = { +import branded from "./arweave.branded.svg" +import dark from "./arweave.dark.svg" +import light from "./arweave.light.svg" + +export { branded, dark, light }; + +export const meta: ___InternalChain = { id: 'arweave', graph_id: 'arweave-mainnet', name: 'Arweave', @@ -37,5 +43,3 @@ const meta: ___InternalChain = { website: 'https://arweave.org/', }, }; - -export default meta; diff --git a/data/chains/V2/avalanche/meta.ts b/data/chains/V2/avalanche/meta.ts index 9ce83b3..cc5e7e5 100644 --- a/data/chains/V2/avalanche/meta.ts +++ b/data/chains/V2/avalanche/meta.ts @@ -1,6 +1,12 @@ import { ___InternalChain } from '../../../../types/chain.types'; -const meta: ___InternalChain = { +import branded from "./avalanche.branded.svg" +import dark from "./avalanche.dark.svg" +import light from "./avalanche.light.svg" + +export { branded, dark, light }; + +export const meta: ___InternalChain = { id: 'avalanche', graph_id: 'avalanche', name: 'Avalanche', @@ -35,6 +41,4 @@ const meta: ___InternalChain = { metadata: { website: 'https://www.avax.network/', }, -}; - -export default meta; +}; \ No newline at end of file diff --git a/data/chains/V2/index.ts b/data/chains/V2/index.ts index a04df60..de501d0 100644 --- a/data/chains/V2/index.ts +++ b/data/chains/V2/index.ts @@ -1,12 +1,12 @@ // This file is auto-generated on pre-commit to avoid maintaining it. // Do not modify manually as it will be overwritten. -// Last generation on 8/7/2024, 3:09:27 PM. +// Last generation on 8/7/2024, 2:24:44 PM. -export { default as arbone } from './arbone/meta'; +export * as arbone from './arbone/meta'; export { default as arbgoerli } from './arbone/testnets/arbgoerli/meta'; export { default as arbsepolia } from './arbone/testnets/arbsepolia/meta'; -export { default as arweave } from './arweave/meta'; -export { default as avalanche } from './avalanche/meta'; +export * as arweave from './arweave/meta'; +export * as avalanche from './avalanche/meta'; export { default as base } from './base/meta'; export { default as bitcoin } from './bitcoin/meta'; export { default as blast } from './blast/meta'; @@ -69,4 +69,4 @@ export { default as zkastar } from './zkastar/meta'; export { default as zkatana } from './zkastar/testnets/zkatana/meta'; export { default as zkyoto } from './zkastar/testnets/zkyoto/meta'; export { default as zksync } from './zksync/meta'; -export { default as zora } from './zora/meta'; +export { default as zora } from './zora/meta'; \ No newline at end of file diff --git a/index.ts b/index.ts index 3f789ab..4796e38 100644 --- a/index.ts +++ b/index.ts @@ -1,6 +1,7 @@ -import * as chains from './data/chains/V2'; -import * as services from './data/services'; -import * as types from './types'; -import * as utils from './utils'; +import * as chains from './data/chains/V2/index.js'; +import * as services from './data/services.js'; +import * as types from './types/index.js'; +import * as utils from './utils/index.js'; export default { chains, services, types, utils }; +export { chains, services, types, utils }; \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index d2bedb9..a674828 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@pinax/chains", - "version": "2.0.5-rc1", + "version": "2.0.8", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@pinax/chains", - "version": "2.0.5-rc1", + "version": "2.0.8", "devDependencies": { "@token-icons/core": "^2.8.2", "@types/bun": "latest", diff --git a/package.json b/package.json index 1007373..5c253ac 100644 --- a/package.json +++ b/package.json @@ -7,17 +7,20 @@ "metadata", "ssot" ], + "type": "module", "author": "Dominic ", "main": "data/chains/V2/data.json", "types": "/types/index.ts", "files": [ - "index.ts", - "/data/services.ts", - "/data/chains/V2/**/**.svg", - "/data/chains/V1/chains.json", - "/data/chains/V2/chains.json", "/build" ], + "exports": { + ".": { + "import": "./build/index.js", + "types": "./build/index.d.ts", + "default": "./build/index.js" + } + }, "scripts": { "fetch-graph-ids": "bun ./scripts/fetchGraphIDs.ts", "format": "prettier --log-level warn --write \"./**/*.{js,jsx,ts,tsx}\"", @@ -37,7 +40,8 @@ "generate_v1:type_graphid": "node ./scripts/generate/V1/type_graphid.js", "generate_v1:type_pinaxid": "node ./scripts/generate/V1/type_pinaxid.js", "test": "bun test", - "build": "tsc", + "build": "tsc && bun build ./index.ts --outdir=build", + "prepublishOnly": "npm run build", "prepare": "husky" }, "devDependencies": { diff --git a/test.ts b/test.ts new file mode 100644 index 0000000..9362dd9 --- /dev/null +++ b/test.ts @@ -0,0 +1,5 @@ +import * as chains from './build/index' + +console.log(chains.chains.arbone.branded) +console.log(chains.chains.arweave.branded) +console.log(chains.chains.arweave.meta) \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 29fda06..10a05ae 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,97 +1,18 @@ { "compilerOptions": { - /* Visit https://aka.ms/tsconfig to read more about this file */ - /* Projects */ - // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ - // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ - // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ - // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ - /* Language and Environment */ "target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ - // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ - // "jsx": "preserve", /* Specify what JSX code is generated. */ - // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ - // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ - // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ - // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ - // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ - // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ - // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ - // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ - // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ - /* Modules */ "module": "ESNext", /* Specify what module code is generated. */ - // "rootDir": "./", /* Specify the root folder within your source files. */ "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ - // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ - // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ - // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ - // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ - // "types": [], /* Specify type package names to be included without being referenced in a source file. */ - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ - // "resolveJsonModule": true, /* Enable importing .json files. */ - // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ - /* JavaScript Support */ - // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ - // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ - // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ - /* Emit */ "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ "outDir": "./build", /* Specify an output folder for all emitted files. */ - // "removeComments": true, /* Disable emitting comments. */ - // "noEmit": true, /* Disable emitting files from a compilation. */ - // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ - // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ - // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ - // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ - // "newLine": "crlf", /* Set the newline character for emitting files. */ - // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ - // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ - // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ - // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ - // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ - /* Interop Constraints */ - // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ - // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ - // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ - /* Type Checking */ "strict": true, /* Enable all strict type-checking options. */ - // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ - // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ - // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ - // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ - // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ - // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ - // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ - // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ - // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ - // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ - // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ - // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ - // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ - // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ - // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ - // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ - /* Completeness */ - // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */ + "skipLibCheck": true, /* Skip type checking all .d.ts files. */ + "emitDeclarationOnly": true }, - "include": ["index.ts" ], + "include": ["index.ts", "types/*.d.ts", "types/block.types.ts"], "exclude": ["node_modules", "**/*.spec.ts"] } \ No newline at end of file diff --git a/types/index.ts b/types/index.ts index 8731225..d5a68e6 100644 --- a/types/index.ts +++ b/types/index.ts @@ -1,6 +1,6 @@ -export * from './block.types'; -export * from './chain.types'; -export * from './graph.types'; -export * from './pinax.types'; -export * from './service.types'; -export * from './standard.types'; +export * from './block.types.js'; +export * from './chain.types.js'; +export * from './graph.types.js'; +export * from './pinax.types.js'; +export * from './service.types.js'; +export * from './standard.types.js'; diff --git a/types/svg.d.ts b/types/svg.d.ts new file mode 100644 index 0000000..6db6710 --- /dev/null +++ b/types/svg.d.ts @@ -0,0 +1,4 @@ +declare module "*.svg" { + const content: React.FunctionComponent>; + export default content; +} \ No newline at end of file