Merge pull request #22 from datopian/feat/portal-scoped-api

PortalJS Cloud portal-scoped APIs

Author: demenech

README.md

@@ -66,11 +66,7 @@ Then, you can start customizing it locally by following the development instruct
 
 ```bash
 # This is the URL of the CKAN instance. Use the example value if you are using PortalJS Cloud.
-NEXT_PUBLIC_DMS=https://api.cloud.portaljs.com
-
-# Leave it empty if you are not using PortalJS Cloud. This is the name of the main organization for your portal in PortalJS Cloud.
-# You can find the this value in the Organizations page in the PortalJS Cloud dashboard.
-NEXT_PUBLIC_ORG=my-org
+NEXT_PUBLIC_DMS=https://api.cloud.portaljs.com/@my-portal-main-org-name
 ```
 
 4) Run `npm run dev` to start the development server
@@ -218,4 +214,4 @@ Let’s build better data portals together 🚀
 
 **[📚 Docs](https://portaljs.com/docs) • [ 🐛 Report a bug or suggest an idea](https://github.com/datopian/portaljs/issues)**
 
-</div>
+</div>

components/dataset/individualPage/DatasetInfo.tsx

@@ -19,7 +19,7 @@ function uniqueFormat(resources) {
 export default function DatasetInfo({
   dataset,
 }: {
-  dataset: Dataset & { _name: string };
+  dataset: Dataset;
 }) {
   const [isTruncated, setIsTruncated] = useState(false);
   const [showFullDescription, setShowFullDescription] = useState(false);
@@ -212,7 +212,7 @@ export default function DatasetInfo({
           {metaFormats.map((item) => (
             <div key={item.format}>
               <Link
-                href={`${process.env.NEXT_PUBLIC_DMS}/dataset/${dataset._name}.${item.format}`}
+                href={`${process.env.NEXT_PUBLIC_DMS}/dataset/${dataset.name}.${item.format}`}
                 className="font-semibold group flex gap-0.5 hover:text-darkaccent"
               >
                 <div className="text-accent group-hover:text-darkaccent transition flex items-center justify-center">

components/dataset/search/DatasetCard.tsx

@@ -4,8 +4,6 @@ import MultipleResourcesCard from "../_shared/MultipleResourcesCard";
 import { resourceBgColors } from "../_shared/FormatsColors";
 import { getTimeAgo } from "@/lib/utils";
 
-const mainOrg = process.env.NEXT_PUBLIC_ORG;
-
 export default function DatasetCard({
   dataset,
   showOrg = true,
@@ -68,10 +66,7 @@ export default function DatasetCard({
     );
   }
 
-  const datasetName =
-    dataset.name?.indexOf(`${mainOrg}--`) >= 0
-      ? dataset.name?.split(`${mainOrg}--`)[1]
-      : dataset.name;
+  const datasetName = dataset.name;
 
   return (
     <Link href={`/@${dataset.organization.name}/${datasetName}`} className="">

components/dataset/search/DatasetItem.tsx

@@ -6,9 +6,8 @@ import {
   RiOrganizationChart,
   RiPriceTagLine,
 } from "react-icons/ri";
-import { getDatasetName, getOrganizationName, getTimeAgo } from "@/lib/utils";
+import { getTimeAgo } from "@/lib/utils";
 import { useTheme } from "@/components/theme/theme-provider";
-import { TagIcon } from "@heroicons/react/20/solid";
 
 export default function DatasetItem({
   dataset,
@@ -23,7 +22,7 @@ export default function DatasetItem({
 
   return (
     <Link
-      href={`/@${getOrganizationName(dataset.organization.name)}/${getDatasetName(dataset.name)}`}
+      href={`/@${dataset.organization.name}/${dataset.name}`}
       className={`flex items-start gap-4 hover:bg-white hover:shadow-lg transition-all p-4 rounded-[10px] ${styles.shadowMd}`}
     >
       <span className="min-w-[5px] min-h-[5px] bg-accent rounded-full mt-3 hidden"></span>

components/home/mainSection/PopularDatasets.tsx

@@ -1,6 +1,5 @@
 import Link from "next/link";
 import { useTheme } from "@/components/theme/theme-provider";
-import { getDatasetName, getOrganizationName } from "@/lib/utils";
 import { Dataset } from "@/schemas/dataset.interface";
 
 type DatasetLinkProps = Pick<Dataset, "title" | "metadata_modified">;
@@ -28,9 +27,7 @@ export default function PopularDatasets({
           {datasets.map((dataset, index) => (
             <Link
               key={index}
-              href={`/@${getOrganizationName(dataset.organization.name)}/${getDatasetName(
-                dataset.name
-              )}`}
+              href={`/@${dataset.organization.name}/${dataset.name}`}
               className="block mt-6 hover:text-accent transition-all"
             >
               <DatasetLink

lib/queries/dataset.ts

@@ -1,20 +1,13 @@
 import { CKAN } from "@portaljs/ckan";
-import {
-  privateToPublicDatasetName,
-  privateToPublicOrgName,
-  publicToPrivateDatasetName,
-} from "./utils";
 import { Dataset, PackageSearchOptions } from "@/schemas/dataset.interface";
 import CkanRequest, { CkanResponse } from "@portaljs/ckan-api-client-js";
 
 const DMS = process.env.NEXT_PUBLIC_DMS;
-const mainOrg = process.env.NEXT_PUBLIC_ORG;
 
 export async function searchDatasets(options: PackageSearchOptions) {
   const baseAction = `package_search`;
-  const tagVocabName = mainOrg ? `vocab_portal-tags--${mainOrg}` : "tags";
 
-  const facetFields = ["groups", "organization", "res_format", tagVocabName]
+  const facetFields = ["groups", "organization", "res_format", "tags"]
     .map((f) => `"${f}"`)
     .join(",");
 
@@ -36,7 +29,7 @@ export async function searchDatasets(options: PackageSearchOptions) {
     queryParams.push(`sort=${options?.sort}`);
   }
 
-  let fqList: string[] = [mainOrg ? `main_org:${mainOrg}` : ""];
+  let fqList: string[] = [];
 
   if (options?.fq) {
     fqList.push(options.fq);
@@ -52,7 +45,7 @@ export async function searchDatasets(options: PackageSearchOptions) {
   }
 
   if (options?.tags?.length) {
-    fqListGroups.push(`${tagVocabName}:(${joinTermsWithOr(options?.tags)})`);
+    fqListGroups.push(`tags:(${joinTermsWithOr(options?.tags)})`);
   }
 
   if (options?.resFormat?.length) {
@@ -88,11 +81,6 @@ export async function searchDatasets(options: PackageSearchOptions) {
     }>
   >(action, { ckanUrl: DMS });
 
-  const facets = res.result && res.result.search_facets;
-  if (facets && tagVocabName in facets) {
-    res.result.search_facets["tags"] = facets[tagVocabName];
-  }
-
   return { ...res.result, datasets: res.result.results };
 }
 
@@ -103,16 +91,6 @@ const joinTermsWithOr = (tems) => {
 export const getDataset = async ({ name }: { name: string }) => {
   const DMS = process.env.NEXT_PUBLIC_DMS;
   const ckan = new CKAN(DMS);
-  const privateName = publicToPrivateDatasetName(name);
-  const dataset = await ckan.getDatasetDetails(privateName);
-  dataset.name = privateToPublicDatasetName(dataset.name);
-
-  return {
-    ...dataset,
-    _name: privateName,
-    organization: {
-      ...dataset.organization,
-      name: privateToPublicOrgName(dataset.organization.name),
-    },
-  };
+  const dataset = await ckan.getDatasetDetails(name);
+  return dataset
 };

lib/queries/groups.ts

@@ -1,62 +1,17 @@
-import { Dataset, Group } from "@portaljs/ckan";
-import {
-  privateToPublicDatasetName,
-  privateToPublicGroupName,
-  privateToPublicOrgName,
-  publicToPrivateGroupName,
-} from "./utils";
+import { Group } from "@portaljs/ckan";
 import CkanRequest, { CkanResponse } from "@portaljs/ckan-api-client-js";
 
 const DMS = process.env.NEXT_PUBLIC_DMS;
-const mainOrg = process.env.NEXT_PUBLIC_ORG;
-const mainGroup = `${mainOrg}-group`;
 
-export const getAllGroups = async ({
-  detailed = true, // Whether to add group_show or not
-}: {
-  detailed: boolean;
-}) => {
-  if (!mainOrg) {
-    const organizations = await CkanRequest.get<CkanResponse<Group[]>>(
+export const getAllGroups = async () => {
+    const groups = await CkanRequest.get<CkanResponse<Group[]>>(
       `group_list?all_fields=True`,
       {
         ckanUrl: DMS,
       }
     );
 
-    return organizations.result.map((o) => {
-      return { ...o, _name: o.name };
-    });
-  }
-
-  const groupsTree = await CkanRequest.get<
-    CkanResponse<Group & { children: Group[] }>
-  >(`group_tree_section?type=group&id=${mainGroup}`, {
-    ckanUrl: DMS,
-  });
-
-  let children = groupsTree.result.children;
-
-  if (detailed) {
-    children = await Promise.all(
-      children.map(async (g) => {
-        const groupDetails = await CkanRequest.get<CkanResponse<Group>>(
-          `group_show?id=${g.id}`,
-          {
-            ckanUrl: DMS,
-          }
-        );
-        return groupDetails.result;
-      })
-    );
-  }
-
-  children = children.map((c) => {
-    const publicName = privateToPublicGroupName(c.name);
-    return { ...c, name: publicName };
-  });
-
-  return children;
+    return groups.result
 };
 
 export const getGroup = async ({
@@ -66,24 +21,10 @@ export const getGroup = async ({
   name: string;
   include_datasets?: boolean;
 }) => {
-  const privateName = publicToPrivateGroupName(name);
-
   const group = await CkanRequest.get<CkanResponse<Group>>(
-    `group_show?id=${privateName}&include_datasets=${include_datasets}`,
+    `group_show?id=${name}&include_datasets=${include_datasets}`,
     { ckanUrl: DMS }
   );
 
-  if (include_datasets) {
-    group.result.packages.forEach((dataset: Dataset) => {
-      const publicOrgName = privateToPublicOrgName(dataset.organization.name);
-      dataset.organization.name = publicOrgName;
-
-      const publicDatasetName = privateToPublicDatasetName(dataset.name);
-      dataset.name = publicDatasetName;
-    });
-  }
-
-  const publicName = privateToPublicGroupName(group.result.name);
-
-  return { ...group.result, name: publicName, _name: group.result.name };
+  return group.result
 };

lib/queries/orgs.ts

@@ -1,13 +1,7 @@
-import { Dataset, Organization } from "@portaljs/ckan";
-import {
-  privateToPublicDatasetName,
-  privateToPublicOrgName,
-  publicToPrivateOrgName,
-} from "./utils";
+import { Organization } from "@portaljs/ckan";
 import CkanRequest, { CkanResponse } from "@portaljs/ckan-api-client-js";
 
 const DMS = process.env.NEXT_PUBLIC_DMS;
-const mainOrg = process.env.NEXT_PUBLIC_ORG;
 
 export const getOrganization = async ({
   name,
@@ -16,87 +10,21 @@ export const getOrganization = async ({
   name: string;
   include_datasets?: boolean;
 }) => {
-  const privateName = publicToPrivateOrgName(name);
-
   const organization = await CkanRequest.get<CkanResponse<Organization>>(
-    `organization_show?id=${privateName}&include_datasets=${include_datasets}`,
+    `organization_show?id=${name}&include_datasets=${include_datasets}`,
     { ckanUrl: DMS }
   );
 
-  if (include_datasets) {
-    organization.result.packages.forEach((dataset: Dataset) => {
-      dataset.organization.name = name;
-      dataset.name = privateToPublicDatasetName(dataset.name);
-    });
-  }
-
-  const publicName = privateToPublicOrgName(organization.result.name);
-
-  return {
-    ...organization.result,
-    name: publicName,
-    _name: organization.result.name,
-  };
+  return organization.result
 };
 
-export const getAllOrganizations = async ({
-  detailed = true, // Whether to add organization_show or not
-}: {
-  detailed?: boolean;
-}) => {
-  if (!mainOrg) {
-    const organizations = await CkanRequest.get<CkanResponse<Organization[]>>(
-      `organization_list?all_fields=True`,
-      {
-        ckanUrl: DMS,
-      }
-    );
-
-    return organizations.result.map((o) => {
-      return { ...o, _name: o.name };
-    });
-  }
-
-  /*
-   * Get hierarchy from root org
-   *
-   */
-
-  const organizationsTree = await CkanRequest.get<
-    CkanResponse<Organization & { children: Organization[]; _name: string }>
-  >(`group_tree_section?type=organization&id=${mainOrg}`, {
-    ckanUrl: DMS,
-  });
-
-  /*
-   * Flatten orgs hierarchy, fix name and preserve
-   * internal name as `_name`
-   *
-   */
-  const { children, ...parent } = organizationsTree.result;
-
-  let organizations = children.map((c) => {
-    const publicName = privateToPublicOrgName(c.name);
-    return { ...c, name: publicName, _name: c.name };
-  });
-
-  organizations.unshift({ ...parent, _name: parent.name });
-
-  /*
-   * Get details for each org
-   *
-   */
-  if (organizations && detailed) {
-    organizations = await Promise.all(
-      organizations.map(async (o) => {
-        const orgDetails = await getOrganization({
-          name: o.name,
-        });
-
-        return { ...o, ...orgDetails, name: o.name, _name: o._name };
-      })
-    );
-  }
+export const getAllOrganizations = async () => {
+  const organizations = await CkanRequest.get<CkanResponse<Organization[]>>(
+    `organization_list?all_fields=True`,
+    {
+      ckanUrl: DMS,
+    }
+  );
 
-  return organizations;
+  return organizations.result
 };