chore: add api extractor

ryanleecode · ryanleecode · commit fa2d7aa8ac18 · 2024-10-09T00:18:32.000-04:00
diff --git a/.changeset/olive-drinks-double.md b/.changeset/olive-drinks-double.md
@@ -0,0 +1,7 @@
+---
+"@systemfsoftware/api-extractor": patch
+"@systemfsoftware/effect": patch
+"@systemfsoftware/aws": patch
+---
+
+chore: add api extractor
diff --git a/package.json b/package.json
@@ -11,6 +11,7 @@
     "format:check": "dprint check"
   },
   "devDependencies": {
+    "@microsoft/api-extractor": "^7.47.9",
     "@total-typescript/tsconfig": "^1.0.4",
     "dprint": "^0.47.2",
     "rimraf": "^6.0.1",
diff --git a/packages/api-extractor/api-extractor.json b/packages/api-extractor/api-extractor.json
diff --git a/packages/api-extractor/package.json b/packages/api-extractor/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "@systemfsoftware/api-extractor",
+  "version": "0.0.0",
+  "author": "Ryan Lee <ryanleecode@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/systemfsoftware/essentials.git"
+  },
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    "./api-extractor.json": "./api-extractor.json"
+  },
+  "keywords": [
+    "aws"
+  ],
+  "files": [
+    "api-extractor.json"
+  ]
+}
diff --git a/packages/aws/api-extractor.json b/packages/aws/api-extractor.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "@systemfsoftware/api-extractor/api-extractor.json"
+}
diff --git a/packages/aws/package.json b/packages/aws/package.json
@@ -79,9 +79,12 @@
   "scripts": {
     "prepare": "pnpm turbo build",
     "clean": "rimraf dist .tshy .tshy-build",
-    "build": "pnpm run clean && tshy"
+    "build": "pnpm run clean && tshy && pnpm run extract",
+    "extract": "api-extractor run"
   },
   "dependencies": {},
-  "devDependencies": {},
+  "devDependencies": {
+    "@systemfsoftware/api-extractor": "workspace:^"
+  },
   "peerDependencies": {}
 }
diff --git a/packages/aws/src/cloudfront/cache-policy.ts b/packages/aws/src/cloudfront/cache-policy.ts
@@ -1,28 +1,35 @@
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-amplify}
  */
 export const AMPLIFY = '2e54312d-136d-493c-8eb9-b001f22f67d2'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-caching-disabled}
  */
 export const CACHING_DISABLED = '4135ea2d-6df8-44a3-9df3-4b5a84be39ad'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-caching-optimized}
  */
 export const CACHING_OPTIMIZED = '658327ea-f89d-4fab-a63d-7e88639e58f6'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-caching-optimized-uncompressed}
  */
 export const CACHING_OPTIMIZED_FOR_COMPRESSED_OBJECTS = 'b2884449-e4de-46a7-ac36-70bc7f1ddd6d'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-mediapackage}
  */
 export const ELEMENTAL_MEDIA_PACKAGE = '08627262-05a9-4f76-9ded-b50ca2e3a84f'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers}
  */
 export const USE_ORIGIN_CACHE_CONTROL_HEADERS = '83da9c7e-98b4-4e11-a168-04f0df8e2c65'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html#managed-cache-policy-origin-cache-headers-query-strings}
  */
 export const USE_ORIGIN_CACHE_CONTROL_HEADERS_QUERY_STRING = '4cc15a8a-d715-48a4-82b8-cc0b614638fe'
diff --git a/packages/aws/src/cloudfront/origin-request.ts b/packages/aws/src/cloudfront/origin-request.ts
@@ -1,28 +1,35 @@
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer}
  */
 export const ALL_VIEWER = '216adef6-5c7f-47e4-b989-5492eafa07d3'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer-and-cloudfront}
  */
 export const ALL_VIEWER_AND_CLOUDFRONT_HEADERS_2022_06 = '33f36d7e-f396-46d9-90e0-52428a34d9dc'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-all-viewer-except-host-header}
  */
 export const ALL_VIEWER_EXCEPT_HOST_HEADER = 'b689b0a8-53d0-40ab-baf2-68738e2966ac'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-cors-custom}
  */
 export const CORS_CUSTOM_ORIGIN = '59781a5b-3903-41f3-afcb-af62929ccde1'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-cors-s3}
  */
 export const CORS_S3_ORIGIN = '88a5eaf4-2fd4-4709-b370-b4c650ea3fcf'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-mediatailor}
  */
 export const ELEMENTAL_MEDIA_TAILOR_PERSONALIZED_MANIFESTS = '775133bc-15f2-49f9-abea-afb2e0bf67d2'
 /**
+ * @public
  * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html#managed-origin-request-policy-user-agent-referer}
  */
 export const USER_AGENT_REFERER_HEADERS = 'acba4595-bd28-49b8-b9fe-13317c0390fa'
diff --git a/packages/effect/api-extractor.json b/packages/effect/api-extractor.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "@systemfsoftware/api-extractor/api-extractor.json"
+}
diff --git a/packages/effect/package.json b/packages/effect/package.json
@@ -55,11 +55,13 @@
   "scripts": {
     "prepare": "pnpm turbo build",
     "clean": "rimraf dist .tshy .tshy-build",
-    "build": "pnpm run clean && tshy"
+    "build": "pnpm run clean && tshy && pnpm run extract",
+    "extract": "api-extractor run"
   },
   "dependencies": {},
   "devDependencies": {
-    "effect": "catalog:"
+    "effect": "catalog:",
+    "@systemfsoftware/api-extractor": "workspace:^"
   },
   "peerDependencies": {
     "effect": "^3.8.0"
diff --git a/packages/effect/src/log-layer.ts b/packages/effect/src/log-layer.ts
@@ -1,12 +1,18 @@
 import { Config as C, Effect, Layer, Logger, Option, pipe } from 'effect'
 
+/**
+ * @public
+ */
 export namespace LogLayer {
   export type LogLayer = Layer.Layer<never, never, never>
   export type Config = {
     readonly NODE_ENV: C.Config<Option.Option<string>>
   }
 }
 
+/**
+ * @public
+ */
 export const LogLayer: LogLayer.LogLayer = Layer.unwrapEffect(
   Effect.gen(function*() {
     const NODE_ENV = yield* pipe(Config.NODE_ENV, Effect.orDie)
@@ -19,6 +25,9 @@ export const LogLayer: LogLayer.LogLayer = Layer.unwrapEffect(
   }),
 )
 
+/**
+ * @public
+ */
 export const Config: LogLayer.Config = Object.freeze({
   NODE_ENV: pipe(
     C.string('NODE_ENV'),
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
 +  "extends": "@systemfsoftware/api-extractor/api-extractor.json"
 +}