Split papi.d.ts (#251)

extensions/.eslintrc.cjs

@@ -1,9 +1,16 @@
 module.exports = {
   extends: '../.eslintrc.js',
   rules: {
-    strict: 'off',
     'import/no-unresolved': ['error', { ignore: ['papi'] }],
   },
+  overrides: [
+    {
+      files: ['*.js'],
+      rules: {
+        strict: 'off',
+      },
+    },
+  ],
   settings: {
     'import/resolver': {
       // See https://github.com/benmosher/eslint-plugin-import/issues/1396#issuecomment-575727774 for line below

extensions/lib/evil/evil.js

@@ -3,7 +3,7 @@
 'use strict';
 
 // eslint-disable-next-line import/no-unresolved
-const papi = require('papi');
+const papi = require('papi-backend');
 
 const { logger } = papi;
 

extensions/lib/hello-someone/hello-someone.ts

@@ -1,4 +1,4 @@
-import papi from 'papi';
+import papi from 'papi-backend';
 import type {
   WebViewContentType,
   WebViewDefinition,

extensions/lib/hello-world/hello-world.ts

@@ -1,4 +1,4 @@
-import papi from 'papi';
+import papi from 'papi-backend';
 import { UnsubscriberAsync } from 'shared/utils/papi-util';
 import type {
   WebViewContentType,

extensions/lib/hello-world/hello-world.web-view.tsx

@@ -1,4 +1,4 @@
-import papi from 'papi';
+import papi from 'papi-frontend';
 import {
   Button,
   Checkbox,

extensions/lib/quick-verse/quick-verse.ts

@@ -1,4 +1,4 @@
-import papi from 'papi';
+import papi from 'papi-backend';
 import type { ExecutionToken } from 'node/models/execution-token.model';
 import type IDataProviderEngine from 'shared/models/data-provider-engine.model';
 import { UnsubscriberAsync } from 'shared/utils/papi-util';

extensions/vite/vite.util.ts

@@ -45,7 +45,12 @@ export const webViewTempDir = 'temp-vite';
 export const webViewTempGlob = `**/${webViewTempDir}/*.web-view.js`;
 
 /** Modules that Paranext supplies so extensions can use them easily */
-export const paranextProvidedModules = ['react', 'react-dom/client', 'papi'];
+export const paranextProvidedModules = [
+  'react',
+  'react-dom/client',
+  'papi-frontend',
+  'papi-backend',
+];
 
 /**
  * Gets a file extension based on the moduleFormat input.

lib/papi-dts/edit-papi-d-ts.ts

@@ -14,8 +14,8 @@ let papiDTS = fs.readFileSync(PAPI_DTS_PATH, 'utf8');
 
 // Rename module 'shared/services/papi.service' to 'papi' so extensions can import just 'papi'
 papiDTS = papiDTS
-  .replaceAll("'renderer/services/papi-renderer.service'", "'papi'")
-  .replaceAll("'extension-host/services/papi-extension-host.service'", "'papi'");
+  .replaceAll("'renderer/services/papi-frontend.service'", "'papi-frontend'")
+  .replaceAll("'extension-host/services/papi-backend.service'", "'papi-backend'");
 
 // Remove all the @ from the @imports except @mui/material  - not sure why these show up
 // as they are all defined other than the css files and external modules

lib/papi-dts/papi.d.ts

@@ -1369,7 +1369,7 @@ declare module 'shared/services/network-object.service' {
       id: string,
       createLocalObjectToProxy?: LocalObjectToProxyCreator<T> | undefined,
     ) => Promise<NetworkObject<T> | undefined>;
-    set: <T_1 extends NetworkableObject<object>>(
+    set: <T_1 extends NetworkableObject>(
       id: string,
       objectToShare: T_1,
     ) => Promise<DisposableNetworkObject<T_1>>;
@@ -2357,7 +2357,7 @@ declare module 'renderer/hooks/papi-hooks/index' {
   export default papiHooks;
   export type PapiHooks = typeof papiHooks;
 }
-declare module 'papi' {
+declare module 'papi-frontend' {
   const papi: {
     react: {
       context: {
@@ -2675,7 +2675,7 @@ declare module 'extension-host/services/extension-storage.service' {
   export default extensionStorageService;
   export type ExtensionStorageService = typeof extensionStorageService;
 }
-declare module 'papi' {
+declare module 'papi-backend' {
   const papi: {
     storage: {
       readTextFileFromInstallDirectory: (

lib/papi-dts/tsconfig.json

@@ -8,8 +8,8 @@
     "typeRoots": ["../node_modules/@types", "../extensions/dist", "../src/@types"]
   },
   "files": [
-    "../../src/renderer/services/papi-renderer.service.ts",
-    "../../src/extension-host/services/papi-extension-host.service.ts",
+    "../../src/renderer/services/papi-frontend.service.ts",
+    "../../src/extension-host/services/papi-backend.service.ts",
     "../../src/extension-host/extension-types/extension.interface.ts"
   ]
 }

src/extension-host/extension-host.ts

@@ -3,7 +3,7 @@ import { isClient } from '@shared/utils/internal-util';
 import * as networkService from '@shared/services/network.service';
 import { CommandHandler } from '@shared/utils/papi-util';
 import * as ExtensionService from '@extension-host/services/extension.service';
-import papi from '@extension-host/services/papi-extension-host.service';
+import papi from '@extension-host/services/papi-backend.service';
 import logger from '@shared/services/logger.service';
 import networkObjectService from '@shared/services/network-object.service';
 import dataProviderService from '@shared/services/data-provider.service';

src/extension-host/services/extension.service.ts

@@ -15,7 +15,7 @@ import {
   getCommandLineArgumentsGroup,
 } from '@node/utils/command-line.util';
 import { setExtensionUris } from '@extension-host/services/extension-storage.service';
-import papi from '@extension-host/services/papi-extension-host.service';
+import papi from '@extension-host/services/papi-backend.service';
 import executionTokenService from '@node/services/execution-token.service';
 import { ExecutionActivationContext } from '@extension-host/extension-types/extension-activation-context.model';
 
@@ -194,7 +194,7 @@ const activateExtensions = async (extensions: ExtensionInfo[]): Promise<ActiveEx
   const requireOriginal = Module.prototype.require;
   Module.prototype.require = ((moduleName: string) => {
     // Allow the extension to import papi
-    if (moduleName === 'papi') return papi;
+    if (moduleName === 'papi-backend') return papi;
 
     // Figure out if we are doing the import for the extension file in activateExtension
     const extensionFile = extensionsWithFiles.find(

src/renderer/global-this.model.ts

@@ -5,7 +5,7 @@
 import React from 'react';
 import { createRoot } from 'react-dom/client';
 import { ProcessType } from '@shared/global-this.model';
-import papi, { Papi } from '@renderer/services/papi-renderer.service';
+import papi, { Papi } from '@renderer/services/papi-frontend.service';
 import { getModuleSimilarApiMessage } from '@shared/utils/papi-util';
 
 // #region webpack DefinePlugin types setup - these should be from the renderer webpack DefinePlugin
@@ -23,7 +23,7 @@ declare const webpackRenderer: {
  * for packages that extensions import
  */
 function webViewRequire(module: string) {
-  if (module === 'papi') return papi;
+  if (module === 'papi-frontend') return papi;
   if (module === 'react') return React;
   if (module === 'react-dom/client') return { createRoot };
   // Tell the extension dev if there is an api similar to what they want to import