feat: hidden-graph

add flag to the published cubes metadata (cc:isHiddenCube)

cli/lib/commands/publish.ts

@@ -29,7 +29,7 @@ export default runner.create<PublishRunOptions>({
     const { publishStore, job: jobUri } = options
     const Hydra = variable.get('apiClient')
 
-    const { job, namespace, cubeIdentifier, cubeCreatorVersion } = await getJob(jobUri, Hydra)
+    const { job, namespace, cubeIdentifier, cubeCreatorVersion, isHiddenCube } = await getJob(jobUri, Hydra)
 
     if (options.to === 'filesystem' && !variable.has('targetFile')) {
       variable.set('targetFile', tempy.file())
@@ -59,6 +59,7 @@ export default runner.create<PublishRunOptions>({
     variable.set('revision', job.revision)
     variable.set('namespace', namespace)
     variable.set('cubeIdentifier', cubeIdentifier)
+    variable.set('isHiddenCube', isHiddenCube)
     logger.info(`Publishing cube <${cubeIdentifier}>`)
   },
   async after(options, variables) {
@@ -77,6 +78,7 @@ async function getJob(jobUri: string, Hydra: HydraClient): Promise<{
   namespace: string
   cubeIdentifier: string
   cubeCreatorVersion: string | undefined | null
+  isHiddenCube: boolean
 }> {
   const jobResource = await Hydra.loadResource<PublishJob>(jobUri)
   const cubeCreatorVersion = jobResource.response?.xhr.headers.get('x-cube-creator')
@@ -105,5 +107,6 @@ async function getJob(jobUri: string, Hydra: HydraClient): Promise<{
     namespace: datasetResource.representation?.root?.hasPart[0].id.value,
     cubeIdentifier,
     cubeCreatorVersion,
+    isHiddenCube: project.isHiddenCube,
   }
 }

cli/lib/publish/hiddenCube.ts

@@ -0,0 +1,25 @@
+import type { Context } from 'barnard59-core/lib/Pipeline'
+import $rdf from 'rdf-ext'
+import through2 from 'through2'
+import clownface from 'clownface'
+import { cc } from '@cube-creator/core/namespace'
+
+export function inject(this: Pick<Context, 'variables'>) {
+  const isHiddenCube = this.variables.get('isHiddenCube')
+  const cubeNamespace = this.variables.get('namespace')
+  const revision = this.variables.get('revision')
+
+  const cubeId = $rdf.namedNode(`${cubeNamespace}/${revision}`)
+
+  const dataset = $rdf.dataset()
+  clownface({ dataset })
+    .node(cubeId)
+    .addOut(cc.isHiddenCube, !!isHiddenCube)
+
+  return through2.obj(
+    (chunk, enc, cb) => cb(null, chunk),
+    function (done) {
+      dataset.forEach(this.push.bind(this))
+      done()
+    })
+}

cli/lib/variables.ts

@@ -39,5 +39,6 @@ declare module 'barnard59-core' {
     originalValueQuads: DatasetExt
     cubeCreatorVersion: string
     cliVersion: string
+    isHiddenCube: boolean
   }
 }

cli/pipelines/publish.ttl

@@ -49,6 +49,7 @@
   :steps [ :stepList ( <#loadCube>
                        <#countInputQuads>
                        <#injectCubeRevision>
+                       <#injectIsHiddenCube>
                        <#injectObservedBy>
                        <#injectSoftwareVersions>
                      ) ]
@@ -245,6 +246,11 @@ _:get
                        a         code:EcmaScript ] ;
   code:arguments     ( "jobUri"^^:VariableName ) .
 
+<#injectIsHiddenCube>
+  a :Step ;
+  code:implementedBy [ code:link <file:../lib/publish/hiddenCube#inject> ;
+                       a         code:EcmaScript ] .
+
 <#injectSoftwareVersions>
   a :Step ;
   code:implementedBy [ code:link <file:../lib/publish/versions#inject> ;