update docs to follow standards and be consistent

Author: aklinker1

docs/content/proxy-service/0.installation.md

@@ -25,27 +25,27 @@ import type { MathService } from './MathService';
 //     ^^^^ IMPORTANT: do not import the math service's value, just it's type.
 
 // 2. [Optional] Define a key with a branded type to ensure type-safety
-export const MathServiceKey = 'math-service' as ProxyServiceKey<MathService>;
+export const MATH_SERVICE_KEY = 'math-service' as ProxyServiceKey<MathService>;
 ```
 
 ```ts [background.ts]
 import { registerService } from '@webext-core/proxy-service';
 import { MathService } from './MathService';
-import { MathServiceKey } from './proxy-service-keys';
+import { MATH_SERVICE_KEY } from './proxy-service-keys';
 
 // 3. Instantiate your service
 const mathService = new MathService();
 
 // 4. Register the service BEFORE awaiting anything
-registerService(MathServiceKey, mathService);
+registerService(MATH_SERVICE_KEY, mathService);
 ```
 
 ```ts [anywhere-else.ts]
 import { createProxyService } from './MathService';
-import { MathServiceKey } from './proxy-service-keys';
+import { MATH_SERVICE_KEY } from './proxy-service-keys';
 
 // 5. Get a proxy of your service
-const mathService = createProxyService(MathServiceKey);
+const mathService = createProxyService(MATH_SERVICE_KEY);
 
 // 6. Call methods like normal, they will execute in the background
 await mathService.fibonacci(100);
@@ -129,20 +129,20 @@ Now that you have a service implemented, we need to register it in the backgroun
 import type { ProxyServiceKey } from '@webext-core/proxy-service';
 import type { TodosRepo } from './todos-repo';
 
-export const TodosRepoKey = 'todos-repo' as ProxyServiceKey<TodosRepo>;
+export const TODOS_REPO_KEY = 'todos-repo' as ProxyServiceKey<TodosRepo>;
 ```
 
 ```ts [background.ts]
 import { registerService } from '@webext-core/proxy-service';
 import { openDB } from 'idb';
 import { createTodosRepo } from './todos-repo';
-import { TodosRepoKey } from './proxy-service-keys';
+import { TODOS_REPO_KEY } from './proxy-service-keys';
 
 // DO NOT await the promise here. registerService must be called synchronously.
 const idbPromise = openDB("todos", ...);
 
 const todosRepo = createTodosRepo(idbPromise);
-registerService(TodosRepoKey, todosRepo);
+registerService(TODOS_REPO_KEY, todosRepo);
 ```
 
 ::
@@ -159,22 +159,22 @@ And that's it. You can now access your IndexedDB database from any JS context in
 
 ```html [extension-page.html]
 <script type="module">
-  import { TodosRepoKey } from './proxy-service-keys';
+  import { TODOS_REPO_KEY } from './proxy-service-keys';
   import { createProxyService } from '@webext-core/proxy-service';
 
   // On your UIs
-  const todosRepo = createProxyService(TodosRepoKey);
+  const todosRepo = createProxyService(TODOS_REPO_KEY);
   const todos = await todosRepo.getAll();
   console.log(todos);
 </script>
 ```
 
 ```ts [content-script.ts]
-import { TodosRepoKey } from './proxy-service-keys';
+import { TODOS_REPO_KEY } from './proxy-service-keys';
 import { createProxyService } from '@webext-core/proxy-service';
 
 // Inside content scripts
-const todosRepo = createProxyService(TodosRepoKey);
+const todosRepo = createProxyService(TODOS_REPO_KEY);
 const todos = await todosRepo.getAll();
 console.log(todos);
 ```

docs/content/proxy-service/2.service-keys.md

@@ -29,5 +29,5 @@ import type { ProxyServiceKey } from '@webext-core/proxy-service';
 import type { MathService } from './math-service';
 //     ^^^^ DO NOT FORGET THE type KEYWORD
 
-export const MathServiceKey = 'math-service' as ProxyServiceKey<MathService>;
+export const MATH_SERVICE_KEY = 'math-service' as ProxyServiceKey<MathService>;
 ```

packages/proxy-service-demo/src/entrypoints/background.ts

@@ -1,5 +1,5 @@
 import { registerService } from '@webext-core/proxy-service';
 
 export default defineBackground(() => {
-  registerService(MathServiceKey, new MathService());
+  registerService(MATH_SERVICE_KEY, new MathService());
 });

packages/proxy-service-demo/src/entrypoints/popup/main.ts

@@ -14,7 +14,7 @@ const [multiplyButton, multiplyPre] = getMathServiceElements('multiply');
 const [divideButton, dividePre] = getMathServiceElements('divide');
 const [factorialButton, factorialPre] = getMathServiceElements('factorial');
 
-const mathService = createProxyService(MathServiceKey);
+const mathService = createProxyService(MATH_SERVICE_KEY);
 
 addButton.addEventListener('click', async () => {
   addPre.innerText = 'Loading...';

packages/proxy-service-demo/src/utils/proxy-service-keys.ts

@@ -1,4 +1,4 @@
 import { ProxyServiceKey } from '@webext-core/proxy-service';
 import type { MathService } from './math-service';
 
-export const MathServiceKey = 'math-service' as ProxyServiceKey<MathService>;
+export const MATH_SERVICE_KEY = 'math-service' as ProxyServiceKey<MathService>;

packages/proxy-service/src/index.ts

@@ -1,10 +1,10 @@
-import { DeepAsync, Service } from './types';
 import {
   defineExtensionMessaging,
   ExtensionMessagingConfig,
   ExtensionMessenger,
   RemoveListenerCallback,
 } from '@webext-core/messaging';
+import { DeepAsync, Service } from './types';
 
 /**
  * A type that ensures a service has only async methods.
@@ -66,19 +66,17 @@ interface ProxyServiceConstraint<_> {}
  * import type { ProxyServiceKey } from '@webext-core/proxy-service';
  * import type { MathService } from './math-service';
  *
- * export const ProxyServiceKey = {
- *   MathService: 'MathService' as ProxyServiceKey<MathService>,
- * }
+ * export const PROXY_SERVICE_KEY = 'math-service' as ProxyServiceKey<MathService>;
  *
  * // background.ts
- * import { ProxyServiceKey } from './utils/proxy-service-keys';
+ * import { PROXY_SERVICE_KEY } from './utils/proxy-service-keys';
  *
- * registerService(ProxyServiceKey.MathService, new MathService())
+ * registerService(PROXY_SERVICE_KEY, new MathService())
  *
  * // content-script.ts
- * import { ProxyServiceKey } from './utils/proxy-service-keys';
+ * import { PROXY_SERVICE_KEY } from './utils/proxy-service-keys';
  *
- * const mathService = await createProxyService(ProxyServiceKey.MathService);
+ * const mathService = await createProxyService(PROXY_SERVICE_KEY);
  * ```
  */
 export type ProxyServiceKey<T> = string & ProxyServiceConstraint<T>;