Merge branch 'main' into 108-contents_action_buttons

Author: nils-pzr

packages/client/news/+sharing.feature

@@ -0,0 +1 @@
+Added Sharing get and update methods @pnicolli

packages/client/src/client.ts

@@ -117,6 +117,9 @@ export default class PloneClient {
 
   search = restapi.search;
 
+  getSharing = restapi.getSharing;
+  updateSharing = restapi.updateSharing;
+
   getSite = restapi.getSite;
 
   getSource = restapi.getSource;

packages/client/src/restapi/index.ts

@@ -91,6 +91,9 @@ export { deleteRules } from './rules/delete';
 
 export { search } from './search/get';
 
+export { getSharing } from './sharing/get';
+export { updateSharing } from './sharing/update';
+
 export { getSite } from './site/get';
 
 export { getSource } from './sources/get';

packages/client/src/restapi/sharing/get.test.ts

@@ -0,0 +1,53 @@
+import ploneClient from '../../client';
+import { setup, teardown } from '../../utils/test';
+import { afterEach, beforeEach, describe, expect, test } from 'vitest';
+import type { RequestError } from '../types';
+
+const cli = ploneClient.initialize({
+  apiPath: 'http://localhost:55001/plone',
+});
+
+await cli.login({ data: { login: 'admin', password: 'secret' } });
+
+beforeEach(async () => {
+  await setup();
+});
+
+afterEach(async () => {
+  await teardown();
+});
+
+describe('Get Sharing', () => {
+  test('Successful', async () => {
+    const path = '/';
+
+    const result = await cli.getSharing({ path });
+
+    expect(result.data.inherit).toBe(true);
+  });
+
+  test('Successful - page', async () => {
+    const contentData = {
+      '@type': 'Document',
+      title: 'sharingtest',
+    };
+
+    await cli.createContent({ path: '/', data: contentData });
+
+    const result = await cli.getSharing({ path: contentData.title });
+
+    expect(result.data.inherit).toBe(true);
+  });
+
+  // TODO test sharing with search param
+
+  test('Failure', async () => {
+    const path = 'blah';
+
+    try {
+      await cli.getSharing({ path });
+    } catch (err) {
+      expect((err as RequestError).status).toBe(404);
+    }
+  });
+});

packages/client/src/restapi/sharing/get.ts

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+import { apiRequest, type ApiRequestParams } from '../../api';
+import type { SharingResponse } from '@plone/types';
+import type PloneClient from '../../client';
+import type { RequestResponse } from '../types';
+
+const getSharingSchema = z.object({
+  path: z.string(),
+  search: z.string().optional(),
+});
+
+export type SharingArgs = z.infer<typeof getSharingSchema>;
+
+export async function getSharing(
+  this: PloneClient,
+  { path, search }: SharingArgs,
+): Promise<RequestResponse<SharingResponse>> {
+  const validatedArgs = getSharingSchema.parse({
+    path,
+    search,
+  });
+
+  const options: ApiRequestParams = {
+    config: this.config,
+    params: { search },
+  };
+  const sharingPath = `${validatedArgs.path}/@sharing`;
+
+  return apiRequest('get', sharingPath, options);
+}

packages/client/src/restapi/sharing/update.test.ts

@@ -0,0 +1,80 @@
+import { setup, teardown } from '../../utils/test';
+import { afterEach, beforeEach, describe, expect, test } from 'vitest';
+import PloneClient from '../../client';
+import type { RequestError } from '../types';
+
+const cli = PloneClient.initialize({
+  apiPath: 'http://localhost:55001/plone',
+});
+
+await cli.login({ data: { login: 'admin', password: 'secret' } });
+
+beforeEach(async () => {
+  await setup();
+});
+
+afterEach(async () => {
+  await teardown();
+});
+
+describe('Sharing', () => {
+  test('Successful', async () => {
+    const path = '/';
+    const contentData = {
+      '@type': 'Document',
+      title: 'sharingpage',
+    };
+    await cli.createContent({ path, data: contentData });
+
+    const result = await cli.updateSharing({
+      path: contentData.title,
+      data: {
+        entries: [
+          {
+            id: 'AuthenticatedUsers',
+            roles: {
+              Contributor: true,
+              Editor: false,
+              Reader: false,
+              Reviewer: false,
+            },
+            type: 'group',
+          },
+        ],
+      },
+    });
+
+    expect(result.status).toBe(204);
+  });
+
+  test('Failure', async () => {
+    const path = '/';
+    const contentData = {
+      '@type': 'Document',
+      title: 'sharingpage',
+    };
+    await cli.createContent({ path, data: contentData });
+
+    try {
+      await cli.updateSharing({
+        path: 'blah',
+        data: {
+          entries: [
+            {
+              id: 'AuthenticatedUsers',
+              roles: {
+                Contributor: true,
+                Editor: false,
+                Reader: false,
+                Reviewer: false,
+              },
+              type: 'group',
+            },
+          ],
+        },
+      });
+    } catch (err) {
+      expect((err as RequestError).status).toBe(404);
+    }
+  });
+});

packages/client/src/restapi/sharing/update.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { apiRequest, type ApiRequestParams } from '../../api';
+import { updateSharingDataSchema } from '../../validation/sharing';
+import type PloneClient from '../../client';
+import type { RequestResponse } from '../types';
+
+export const updateSharingArgsSchema = z.object({
+  path: z.string(),
+  data: updateSharingDataSchema.optional(),
+});
+
+export type UpdateSharingArgs = z.infer<typeof updateSharingArgsSchema>;
+
+export async function updateSharing(
+  this: PloneClient,
+  { path, data }: UpdateSharingArgs,
+): Promise<RequestResponse<void>> {
+  const validatedArgs = updateSharingArgsSchema.parse({
+    path,
+    data,
+  });
+
+  const options: ApiRequestParams = {
+    data: validatedArgs.data,
+    config: this.config,
+  };
+
+  const sharingPath = `${validatedArgs.path}/@sharing`;
+
+  return apiRequest('post', sharingPath, options);
+}

packages/client/src/validation/sharing.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+export const updateSharingDataSchema = z.object({
+  entries: z.array(
+    z.object({
+      id: z.string(),
+      roles: z.record(z.string(), z.boolean()),
+      type: z.string(),
+    }),
+  ),
+});

packages/types/news/+sharing.feature

@@ -0,0 +1 @@
+Added Sharing service types @pnicolli

packages/types/src/services/index.d.ts

@@ -27,6 +27,7 @@ export * from './relations';
 export * from './roles';
 export * from './rules';
 export * from './search';
+export * from './sharing';
 export * from './site';
 export * from './sources';
 export * from './system';