Skip to content
This repository was archived by the owner on Dec 18, 2024. It is now read-only.

Commit 0024904

Browse files
NSeydouxMarino Rottier
andauthored
fix: separately import solid functions in storybook examples (#998)
* fix: separately import solid functions in storybook examples * Fix linting --------- Co-authored-by: Marino Rottier <[email protected]>
1 parent 9b3d3ff commit 0024904

9 files changed

+172
-240
lines changed

stories/components/link.stories.tsx

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@
2121

2222
import type { ReactElement } from "react";
2323
import React from "react";
24-
import SolidFns from "@inrupt/solid-client";
24+
import {
25+
addUrl,
26+
createThing,
27+
setThing,
28+
createSolidDataset,
29+
} from "@inrupt/solid-client";
2530
import { Link } from "../../src/components/link";
2631

2732
export default {
@@ -48,11 +53,7 @@ export default {
4853

4954
export function WithChildren({ property }: { property: string }): ReactElement {
5055
const exampleUrl = "http://test.url";
51-
const exampleThing = SolidFns.addUrl(
52-
SolidFns.createThing(),
53-
property,
54-
exampleUrl,
55-
);
56+
const exampleThing = addUrl(createThing(), property, exampleUrl);
5657
return (
5758
<Link thing={exampleThing} property={property}>
5859
<span>Example child</span>
@@ -74,11 +75,7 @@ export function WithoutChildren({
7475
property: string;
7576
}): ReactElement {
7677
const exampleUrl = "http://test.url";
77-
const exampleThing = SolidFns.addUrl(
78-
SolidFns.createThing(),
79-
property,
80-
exampleUrl,
81-
);
78+
const exampleThing = addUrl(createThing(), property, exampleUrl);
8279
return <Link thing={exampleThing} property={property} />;
8380
}
8481

@@ -92,16 +89,9 @@ WithoutChildren.args = {
9289

9390
export function Editable({ property }: { property: string }): ReactElement {
9491
const exampleUrl = "http://test.url";
95-
const exampleThing = SolidFns.addUrl(
96-
SolidFns.createThing(),
97-
property,
98-
exampleUrl,
99-
);
92+
const exampleThing = addUrl(createThing(), property, exampleUrl);
10093

101-
const exampleDataset = SolidFns.setThing(
102-
SolidFns.createSolidDataset(),
103-
exampleThing,
104-
);
94+
const exampleDataset = setThing(createSolidDataset(), exampleThing);
10595

10696
return (
10797
<Link
@@ -124,11 +114,7 @@ Editable.args = {
124114
export function ErrorComponent(): ReactElement {
125115
const exampleUrl = "http://test.url";
126116
const property = "http://xmlns.com/foaf/0.1/homepage";
127-
const exampleThing = SolidFns.addUrl(
128-
SolidFns.createThing(),
129-
property,
130-
exampleUrl,
131-
);
117+
const exampleThing = addUrl(createThing(), property, exampleUrl);
132118
return (
133119
<Link
134120
thing={exampleThing}

stories/components/table.stories.tsx

Lines changed: 80 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,16 @@
2121

2222
import type { ReactElement } from "react";
2323
import React, { useContext } from "react";
24-
import SolidFns from "@inrupt/solid-client";
24+
import type { SolidDataset } from "@inrupt/solid-client";
25+
import {
26+
addDatetime,
27+
addStringNoLocale,
28+
createSolidDataset,
29+
createThing,
30+
getThing,
31+
getUrl,
32+
setThing,
33+
} from "@inrupt/solid-client";
2534
import DatasetContext, {
2635
DatasetProvider,
2736
} from "../../src/context/datasetContext";
@@ -64,27 +73,23 @@ export function BasicExample(): ReactElement {
6473
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
6574
const datePredicate = `http://schema.org/datePublished`;
6675

67-
const thing1A = SolidFns.addStringNoLocale(
68-
SolidFns.createThing(),
76+
const thing1A = addStringNoLocale(
77+
createThing(),
6978
namePredicate,
7079
`example name 1`,
7180
);
72-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
81+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
7382

74-
const thing2A = SolidFns.addStringNoLocale(
75-
SolidFns.createThing(),
83+
const thing2A = addStringNoLocale(
84+
createThing(),
7685
namePredicate,
7786
`example name 2`,
7887
);
79-
const thing2 = SolidFns.addDatetime(
80-
thing2A,
81-
datePredicate,
82-
new Date("1999-01-02"),
83-
);
88+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
8489

85-
const emptyDataset = SolidFns.createSolidDataset();
86-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
87-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
90+
const emptyDataset = createSolidDataset();
91+
const datasetWithThing1 = setThing(emptyDataset, thing1);
92+
const dataset = setThing(datasetWithThing1, thing2);
8893

8994
return (
9095
<Table
@@ -108,41 +113,29 @@ export function MultipleValues(): ReactElement {
108113
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
109114
const nickPredicate = `http://xmlns.com/foaf/0.1/nick`;
110115

111-
const thing1A = SolidFns.addStringNoLocale(
112-
SolidFns.createThing(),
116+
const thing1A = addStringNoLocale(
117+
createThing(),
113118
namePredicate,
114119
`example name 1`,
115120
);
116-
const thing1B = SolidFns.addStringNoLocale(
117-
thing1A,
118-
nickPredicate,
119-
`Nickname`,
120-
);
121-
const thing1C = SolidFns.addStringNoLocale(
122-
thing1B,
123-
nickPredicate,
124-
`Alt Nickname`,
125-
);
126-
const thing1 = SolidFns.addStringNoLocale(
127-
thing1C,
128-
nickPredicate,
129-
`Final Nickname`,
130-
);
121+
const thing1B = addStringNoLocale(thing1A, nickPredicate, `Nickname`);
122+
const thing1C = addStringNoLocale(thing1B, nickPredicate, `Alt Nickname`);
123+
const thing1 = addStringNoLocale(thing1C, nickPredicate, `Final Nickname`);
131124

132-
const thing2A = SolidFns.addStringNoLocale(
133-
SolidFns.createThing(),
125+
const thing2A = addStringNoLocale(
126+
createThing(),
134127
namePredicate,
135128
`example name 2`,
136129
);
137-
const thing2 = SolidFns.addStringNoLocale(
130+
const thing2 = addStringNoLocale(
138131
thing2A,
139132
nickPredicate,
140133
`example nickname 2`,
141134
);
142135

143-
const emptyDataset = SolidFns.createSolidDataset();
144-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
145-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
136+
const emptyDataset = createSolidDataset();
137+
const datasetWithThing1 = setThing(emptyDataset, thing1);
138+
const dataset = setThing(datasetWithThing1, thing2);
146139

147140
return (
148141
<Table
@@ -172,27 +165,23 @@ export function CustomBodyComponent(): ReactElement {
172165
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
173166
const datePredicate = `http://schema.org/datePublished`;
174167

175-
const thing1A = SolidFns.addStringNoLocale(
176-
SolidFns.createThing(),
168+
const thing1A = addStringNoLocale(
169+
createThing(),
177170
namePredicate,
178171
`example name 1`,
179172
);
180-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
173+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
181174

182-
const thing2A = SolidFns.addStringNoLocale(
183-
SolidFns.createThing(),
175+
const thing2A = addStringNoLocale(
176+
createThing(),
184177
namePredicate,
185178
`example name 2`,
186179
);
187-
const thing2 = SolidFns.addDatetime(
188-
thing2A,
189-
datePredicate,
190-
new Date("1999-01-02"),
191-
);
180+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
192181

193-
const emptyDataset = SolidFns.createSolidDataset();
194-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
195-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
182+
const emptyDataset = createSolidDataset();
183+
const datasetWithThing1 = setThing(emptyDataset, thing1);
184+
const dataset = setThing(datasetWithThing1, thing2);
196185

197186
type bodyProps = {
198187
value?: string;
@@ -244,16 +233,13 @@ export function NestedDataExample(): ReactElement {
244233
}: {
245234
numberThingIris: [string];
246235
numberType: string;
247-
dataset: SolidFns.SolidDataset;
236+
dataset: SolidDataset;
248237
}) {
249238
let phoneNumber = "";
250239
numberThingIris.some((numberThingIri) => {
251-
const numberThing = SolidFns.getThing(dataset, numberThingIri);
252-
if (
253-
numberThing &&
254-
SolidFns.getUrl(numberThing, typeProperty) === numberType
255-
) {
256-
phoneNumber = SolidFns.getUrl(numberThing, valueProperty) ?? "";
240+
const numberThing = getThing(dataset, numberThingIri);
241+
if (numberThing && getUrl(numberThing, typeProperty) === numberType) {
242+
phoneNumber = getUrl(numberThing, valueProperty) ?? "";
257243
return true;
258244
}
259245
return false;
@@ -267,11 +253,8 @@ export function NestedDataExample(): ReactElement {
267253
if (!solidDataset) {
268254
return null;
269255
}
270-
const personThing = SolidFns.getThing(
271-
solidDataset,
272-
`${host}/example.ttl#me`,
273-
);
274-
const alterEgoThing = SolidFns.getThing(
256+
const personThing = getThing(solidDataset, `${host}/example.ttl#me`);
257+
const alterEgoThing = getThing(
275258
solidDataset,
276259
`${host}/example.ttl#alterEgo`,
277260
);
@@ -338,27 +321,23 @@ export function SortableColumns(): ReactElement {
338321
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
339322
const datePredicate = `http://schema.org/datePublished`;
340323

341-
const thing1A = SolidFns.addStringNoLocale(
342-
SolidFns.createThing(),
324+
const thing1A = addStringNoLocale(
325+
createThing(),
343326
namePredicate,
344327
`example name 1`,
345328
);
346-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
329+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
347330

348-
const thing2A = SolidFns.addStringNoLocale(
349-
SolidFns.createThing(),
331+
const thing2A = addStringNoLocale(
332+
createThing(),
350333
namePredicate,
351334
`example name 2`,
352335
);
353-
const thing2 = SolidFns.addDatetime(
354-
thing2A,
355-
datePredicate,
356-
new Date("1999-01-02"),
357-
);
336+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
358337

359-
const emptyDataset = SolidFns.createSolidDataset();
360-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
361-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
338+
const emptyDataset = createSolidDataset();
339+
const datasetWithThing1 = setThing(emptyDataset, thing1);
340+
const dataset = setThing(datasetWithThing1, thing2);
362341

363342
return (
364343
<Table
@@ -394,27 +373,23 @@ export function FilterOnFirstColumn({
394373
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
395374
const datePredicate = `http://schema.org/datePublished`;
396375

397-
const thing1A = SolidFns.addStringNoLocale(
398-
SolidFns.createThing(),
376+
const thing1A = addStringNoLocale(
377+
createThing(),
399378
namePredicate,
400379
`example name 1`,
401380
);
402-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
381+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
403382

404-
const thing2A = SolidFns.addStringNoLocale(
405-
SolidFns.createThing(),
383+
const thing2A = addStringNoLocale(
384+
createThing(),
406385
namePredicate,
407386
`example name 2`,
408387
);
409-
const thing2 = SolidFns.addDatetime(
410-
thing2A,
411-
datePredicate,
412-
new Date("1999-01-02"),
413-
);
388+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
414389

415-
const emptyDataset = SolidFns.createSolidDataset();
416-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
417-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
390+
const emptyDataset = createSolidDataset();
391+
const datasetWithThing1 = setThing(emptyDataset, thing1);
392+
const dataset = setThing(datasetWithThing1, thing2);
418393

419394
return (
420395
<Table
@@ -449,27 +424,19 @@ export function SortingFunctionOnFirstColumn(): ReactElement {
449424
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
450425
const datePredicate = `http://schema.org/datePublished`;
451426

452-
const thing1A = SolidFns.addStringNoLocale(
453-
SolidFns.createThing(),
427+
const thing1A = addStringNoLocale(
428+
createThing(),
454429
namePredicate,
455430
"Another Name",
456431
);
457-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
432+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
458433

459-
const thing2A = SolidFns.addStringNoLocale(
460-
SolidFns.createThing(),
461-
namePredicate,
462-
"Name A",
463-
);
464-
const thing2 = SolidFns.addDatetime(
465-
thing2A,
466-
datePredicate,
467-
new Date("1999-01-02"),
468-
);
434+
const thing2A = addStringNoLocale(createThing(), namePredicate, "Name A");
435+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
469436

470-
const emptyDataset = SolidFns.createSolidDataset();
471-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
472-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
437+
const emptyDataset = createSolidDataset();
438+
const datasetWithThing1 = setThing(emptyDataset, thing1);
439+
const dataset = setThing(datasetWithThing1, thing2);
473440

474441
const sortFunction = (a: string, b: string) => {
475442
const valueA = a.split(/\s+/)[1];
@@ -504,27 +471,23 @@ export function NoDataComponent(): ReactElement {
504471
const namePredicate = `http://xmlns.com/foaf/0.1/name`;
505472
const datePredicate = `http://schema.org/datePublished`;
506473

507-
const thing1A = SolidFns.addStringNoLocale(
508-
SolidFns.createThing(),
474+
const thing1A = addStringNoLocale(
475+
createThing(),
509476
namePredicate,
510477
`example name 1`,
511478
);
512-
const thing1 = SolidFns.addDatetime(thing1A, datePredicate, new Date());
479+
const thing1 = addDatetime(thing1A, datePredicate, new Date());
513480

514-
const thing2A = SolidFns.addStringNoLocale(
515-
SolidFns.createThing(),
481+
const thing2A = addStringNoLocale(
482+
createThing(),
516483
namePredicate,
517484
`example name 2`,
518485
);
519-
const thing2 = SolidFns.addDatetime(
520-
thing2A,
521-
datePredicate,
522-
new Date("1999-01-02"),
523-
);
486+
const thing2 = addDatetime(thing2A, datePredicate, new Date("1999-01-02"));
524487

525-
const emptyDataset = SolidFns.createSolidDataset();
526-
const datasetWithThing1 = SolidFns.setThing(emptyDataset, thing1);
527-
const dataset = SolidFns.setThing(datasetWithThing1, thing2);
488+
const emptyDataset = createSolidDataset();
489+
const datasetWithThing1 = setThing(emptyDataset, thing1);
490+
const dataset = setThing(datasetWithThing1, thing2);
528491

529492
return (
530493
<Table

0 commit comments

Comments
 (0)