Merge pull request #8 from allanhvam/dev

1.7.0
allanhvam · Jul 29, 2024 · 4e209ae · 4e209ae
2 parents e8bcbff + d86aa82
commit 4e209ae
Show file tree

Hide file tree

Showing 8 changed files with 298 additions and 85 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "msw-sp",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "description": "MSW handlers for mocking SharePoint REST api.",
     "main": "lib/index.js",
     "engines": {
@@ -9,7 +9,7 @@
     "type": "module",
     "scripts": {
         "build": "npx tsc",
-        "test": "node --test lib/tests/",
+        "test": "node --test",
         "lint": "npx eslint .",
         "watch": "npx tsc --watch"
     },

diff --git a/src/handlers.ts b/src/handlers.ts
@@ -239,6 +239,11 @@ export const handlers = (options: Tenant | { tenant: Tenant, delay?: DelayMode |
             const listRelativeUrl = info.params.listRelativeUrl.toString();
             return response(await tenantMock.sites.getSite(site).rootWeb.getList(listRelativeUrl).get(), info);
         }),
+        ...get("/_api/web/getList\\(':listRelativeUrl'\\)/forms", async (info) => {
+            const site = info.params.site?.toString() || "/";
+            const listRelativeUrl = info.params.listRelativeUrl.toString();
+            return response(await tenantMock.sites.getSite(site).rootWeb.getList(listRelativeUrl).forms.get(), info);
+        }),
         ...get("/_api/web/getList\\(':listRelativeUrl'\\)/fields", async (info) => {
             const site = info.params.site?.toString() || "/";
             const listRelativeUrl = info.params.listRelativeUrl.toString();
@@ -264,6 +269,11 @@ export const handlers = (options: Tenant | { tenant: Tenant, delay?: DelayMode |
             const listId = info.params.listId.toString();
             return response(await tenantMock.sites.getSite(site).rootWeb.lists.getById(listId).items.get(), info);
         }),
+        ...get("/_api/web/lists\\(':listId'\\)/forms", async (info) => {
+            const site = info.params.site?.toString() || "/";
+            const listId = info.params.listId.toString();
+            return response(await tenantMock.sites.getSite(site).rootWeb.lists.getById(listId).forms.get(), info);
+        }),
         ...get("/_api/web/lists/getByTitle\\(':title'\\)/forms", async (info) => {
             const site = info.params.site?.toString() || "/";
             const title = info.params.title.toString();

diff --git a/src/mocks/ListMock.ts b/src/mocks/ListMock.ts
@@ -36,13 +36,31 @@ export class ListMock {
     public get forms() {
         return {
             get: async () => {
+                if (!this.list) {
+                    return new Response(
+                        undefined,
+                        { status: 404 },
+                    );
+                }
+                if (!this.list.forms) {
+                    return new Response(
+                        JSON.stringify([
+                            {
+                                "ServerRelativeUrl": `/${this.list.url || this.list.title}/DispForm.aspx`,
+                                "FormType": 4
+                            },
+                            {
+                                "ServerRelativeUrl": `/${this.list.url || this.list.title}/EditForm.aspx`,
+                                "FormType": 6
+                            }
+                        ]),
+                        { status: 200 },
+                    );
+                }
+
                 return new Response(
-                    JSON.stringify([
-                        {
-                            "ServerRelativeUrl": `/${this.list?.title}/EditForm.aspx`,
-                            "FormType": 6
-                        }
-                    ]),
+                    JSON.stringify(this.list.forms.map(Utils.upperCaseKeys)
+                    ),
                     { status: 200 },
                 );
             }

diff --git a/src/tests/forms.test.ts b/src/tests/forms.test.ts
@@ -0,0 +1,103 @@
+import { SPFx, spfi } from "@pnp/sp";
+import "@pnp/sp/fields/index.js";
+import "@pnp/sp/forms/index.js";
+import "@pnp/sp/items/index.js";
+import "@pnp/sp/lists/index.js";
+import "@pnp/sp/site-users/index.js";
+import "@pnp/sp/sites/index.js";
+import "@pnp/sp/webs/index.js";
+import { setupServer } from 'msw/node';
+import * as assert from "node:assert";
+import { describe, test } from "node:test";
+import { handlers } from '../handlers.js';
+import { PageType } from "../types/List.js";
+
+void describe("forms", async () => {
+    const url = "https://tenant.sharepoint.com";
+    const server = setupServer(...handlers({
+        title: "tenant",
+        url,
+        sites: {
+            "forms": {
+                rootWeb: {
+                    title: "Forms Site",
+                    serverRelativeUrl: "/sites/forms",
+                    lists: [
+                        {
+                            title: "Forms",
+                            baseTemplate: 100,
+                            url: "Lists/Forms",
+                            items: [
+                            ],
+                            forms: [
+                                {
+                                    formType: PageType.DisplayForm,
+                                    serverRelativeUrl: "/sites/forms/Lists/forms/DispForm.aspx",
+                                },
+                            ]
+                        },
+                        {
+                            id: "4e319fc6-3da4-4bcb-87fc-67446cf10aa7",
+                            title: "Default",
+                            baseTemplate: 100,
+                            items: [],
+                            url: "lists/default",
+                        }
+                    ],
+                },
+            },
+        },
+    }));
+    server.listen();
+
+    const getContext = (serverRelativeUrl: string) => {
+        return {
+            pageContext: {
+                web: {
+                    absoluteUrl: `${url}${serverRelativeUrl}`,
+                },
+                legacyPageContext: {
+                    formDigestTimeoutSeconds: 60,
+                    formDigestValue: "digest",
+                },
+            },
+        };
+    };
+
+    await test("forms", async () => {
+        const sp = spfi().using(SPFx(getContext("/sites/forms")));
+
+        const list = sp.web.getList("/sites/forms/lists/forms");
+        const forms = await list.forms();
+
+        assert.equal(forms.length, 1);
+        const form = forms[0];
+
+        assert.equal(form.FormType, PageType.DisplayForm);
+        assert.equal(form.ServerRelativeUrl, "/sites/forms/Lists/forms/DispForm.aspx");
+    });
+
+    await test("default", async () => {
+        const sp = spfi().using(SPFx(getContext("/sites/forms")));
+
+        const list = sp.web.lists.getByTitle("Default");
+        const forms = await list.forms();
+
+        assert.ok(forms.length > 0);
+        const displayForm = forms.find(form => form.FormType === PageType.DisplayForm);
+
+        assert.ok(displayForm);
+    });
+
+    await test("default getById", async () => {
+        const sp = spfi().using(SPFx(getContext("/sites/forms")));
+
+        const list = sp.web.lists.getById("4e319fc6-3da4-4bcb-87fc-67446cf10aa7");
+        const forms = await list.forms();
+
+        assert.ok(forms.length > 0);
+        const displayForm = forms.find(form => form.FormType === PageType.DisplayForm);
+
+        assert.ok(displayForm);
+    });
+});
diff --git a/src/tests/lists.test.ts b/src/tests/lists.test.ts
@@ -1,4 +1,5 @@
 import { SPFx, spfi } from "@pnp/sp";
+import "@pnp/sp/fields/index.js";
 import "@pnp/sp/items/index.js";
 import "@pnp/sp/lists/index.js";
 import "@pnp/sp/site-users/index.js";
@@ -79,7 +80,14 @@ void describe("lists", async () => {
                                     "AuthorId": 1073741822,
                                     "EditorId": 1073741822,
                                 },
-                            ]
+                            ],
+                            fields: [
+                                {
+                                    title: "Id",
+                                    internalName: "ID",
+                                    typeAsString: "Counter",
+                                },
+                            ],
                         },
                     ],
                 },
@@ -163,4 +171,14 @@ void describe("lists", async () => {
         assert.equal(list.ContentTypesEnabled, true);
         assert.equal(list.NoCrawl, true);
     });
+
+    await test("fields", async () => {
+        const sp = spfi().using(SPFx(getContext("/sites/events")));
+
+        const eventList = sp.web.lists.getByTitle("Events");
+        const fields = await eventList.fields.select("InternalName")();
+        assert.equal(fields.length, 1);
+        const field = fields[0];
+        assert.equal(field.InternalName, "ID");
+    });
 });
diff --git a/src/types/Field.ts b/src/types/Field.ts
@@ -14,6 +14,10 @@ type DateTimeField = {
     typeAsString: "DateTime";
 }
 
+type CounterField = {
+    typeAsString: "Counter";
+}
+
 type LookupField = {
     typeAsString: "Lookup";
     lookupField: string;
@@ -24,5 +28,10 @@ export type Field = {
     title: string;
     description?: string;
     internalName: string;
-} & (TextField | LookupField | ComputedField | NumberField | DateTimeField);
+} & (TextField |
+    LookupField |
+    ComputedField |
+    NumberField |
+    DateTimeField |
+    CounterField);
 
diff --git a/src/types/List.ts b/src/types/List.ts
@@ -11,8 +11,32 @@ export type List = {
     contentTypes?: Array<ContentType>;
     hidden?: boolean;
     created?: string;
+    forms?: Array<Form>;
 } & (GenericList | SitePagesList);
 
+export enum PageType {
+    Invalid = -1,
+    DefaultView = 0,
+    NormalView = 1,
+    DialogView = 2,
+    View = 3,
+    DisplayForm = 4,
+    DisplayFormDialog = 5,
+    EditForm = 6,
+    EditFormDialog = 7,
+    NewForm = 8,
+    NewFormDialog = 9,
+    SolutionForm = 10,
+    PAGE_MAXITEMS = 11
+}
+
+export type Form = {
+    id?: string,
+    formType?: PageType,
+    serverRelativeUrl?: string,
+    decodedUrl?: string,
+}
+
 // https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-wssts/8bf797af-288c-4a1d-a14b-cf5394e636cf
 export type GenericList = {
     /**