feat: add typings, and ability to import typings, to package (#11)

square · Jun 4, 2021 · f80c4ee · f80c4ee
1 parent 39fd900
commit f80c4ee
Show file tree

Hide file tree

Showing 8 changed files with 177 additions and 1,120 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,6 @@
   "type": "module",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc --project tsconfig.json",
     "clean": "rm -rf .eslintcache coverage/ dist/",
@@ -133,5 +132,8 @@
         }
       ]
     ]
+  },
+  "dependencies": {
+    "@square/web-payments-sdk-types": "^1.1.1"
   }
 }
diff --git a/src/index.test.ts b/src/index.test.ts
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1,2 @@
 export * from './payments';
+export * from '@square/web-payments-sdk-types';
diff --git a/src/load.ts b/src/load.ts
@@ -1,4 +1,4 @@
-/// <reference path='../types/index.d.ts' />
+import { Square } from '@square/web-payments-sdk-types';
 
 function findScript(src: string): HTMLScriptElement | null {
   return document.querySelector<HTMLScriptElement>(`script[src="${src}"]`);

diff --git a/src/payments.ts b/src/payments.ts
@@ -1,7 +1,13 @@
 import { loadSquare } from './load';
+import { Payments } from '@square/web-payments-sdk-types';
 
 const Version = 'v0';
 
+type PaymentInitialization = (
+  applicationId: string,
+  locationId: string
+) => Promise<Payments | null>;
+
 class InvalidApplicationIdError extends Error {
   constructor(
     message = "The Payment 'applicationId' option is not in the correct format."
@@ -31,7 +37,8 @@ function getSrcForApplicationId(applicationId: string): string {
   return src;
 }
 
-export async function payments(
+// eslint-disable-next-line func-style
+const payments: PaymentInitialization = async function (
   applicationId: string,
   locationId?: string,
   overrides?: {
@@ -50,4 +57,6 @@ export async function payments(
   }
 
   return maybeSquare.payments(applicationId, locationId);
-}
+};
+
+export { payments };
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
+    "typeRoots": ["./node_modules/@square/web-payments-sdk-types"],
     "module": "ESNext",
     "moduleResolution": "node",
     "outDir": "dist/",

diff --git a/types/index.d.ts b/types/index.d.ts
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export * from './payments';
		export * from '@square/web-payments-sdk-types';